public apis for sheikh alamoud official website

Setup:

  npm i
  npm i -g sequelize-cli
  npm run setup-database
  node console.js
  > generate_science_parent_uid()  // this command for re arrange scinces dependencies to use unique identifiers

ORM console:

  cd <PROJECT_ROOT_PATH>
  node console.js

ORM console usage:

fetch all data:

  MODEL_NAME.findAll({raw: true}).then(console.log).catch(console.log)

create record:

  MODEL_NAME.create({<attributes written here>}).then(console.log).catch(console.log)

Deployment:

ssh <VPC ADDRESS>
cd <PROJECT PATH>
git pull origin HEAD
source .env
pm2 restart core --update-env

note: .env file contains secret environment variables. update it manually, then source it using "source .env"

API Doc:

GET Sessions

URI: GET /apis/sessions
// mainly these Query attributes for filteration purpose
Query: {
        days: Array (optional)
        location_ids: Array<String> (optional)
        system_ids: Array<String> (optional)
        science_ids: Array<String> (optional)
        instructor_ids: Array<String> (optional)
        tag_ids: Array<String> (optional)
        tag_names: Array<String> (optional)
        rowaq_id: Integer enum[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12] (optional)
        after_date: String (optional), format: yyyy-mm-dd
        before_date: String (optional), format: yyyy-mm-dd
}
Response: Array<Object>
[{
       uid: string,
       name: string,
       description: longText,
       days: array,
       start_time: timestamp,
       end_time: timestamp,
       start_date: datetime,
       end_date: datetime,
       soundcloud_url: string,
       youtube_url: string,
       google_url: string,
       book: name,
       cost: float,
       rowaq_id: integer,
       payment_url: string,
       duration: integer // duration in minutes
       system: Object,
       location: Object,
       sciences: Array<Object>
       instructors: Array<Object>
       tags: Array<Object>
}]

GET Specific Sessions

URI: GET /apis/sessions/:uid
// mainly these Query attributes for filteration purpose
Query: {}
Response: Object
{
       uid: string,
       name: string,
       description: longText,
       days: array,
       start_time: timestamp,
       end_time: timestamp,
       start_date: datetime,
       end_date: datetime,
       soundcloud_url: string,
       youtube_url: string,
       google_url: string,
       book: name,
       cost: float,
       rowaq_id: integer,
       payment_url: string,
       duration: integer // duration in minutes
       system: Object,
       location: Object,
       sciences: Array<Object>
       instructors: Array<Object>
       tags: Array<Object>
}

Get Systems

URI: GET /apis/systems
Query: {}
Response: Array
[{
       uid: string,
       name: string,
       description: longText
}]

GET Instructors

URI: GET /apis/instructors
Query: {}
Response: Array
[{
       uid: string, // unique id
       name: string, // name of the instructor
       avatar: string, // personal image link of the instructor
       status: int, // 0 = previous instructor, 1 = current instructor
       order: int // first in order is the smallest number
}]

GET specific instructor

URI: GET /apis/instructors/:uid
Query: {}
Response: object
{
       uid: string,
       name: string,
       avatar: string,
       sessions: <Array>
}

Get Sciences

URI: GET /apis/sciences
Query: {}
Response: <Array>object
[{
       uid: string,
       name: string,
       parent_id: integer,
       parent_uid: string // uid: unique identifier of its parent
}]

GET FAQ

URI: GET /apis/faq
Query: {}
Response: Array<Object>
[{
       uid: string,
       question: string,
       answer: longText
}]

Database Regular Backup:

database backup happen every Friday.

postgresql database regularly backedup by a cron to check the cron command write the following on the server:

    crontab -e

the database backup cron command is:

    0 0 1 1-12 5 sudo pg_dump -U alamoud -Fc sheikh_alamoud_production > /home/backups/$(date +\%Y\%m\%d\%H\%M\%S)_sheikh_alamoud_production_backup.sql > /var/log/backup.log

NOTE: in order to make this command working the file .pgpass must be exist in $HOME directory ~/. it contains the following line:

    localhost:5432:DATABSE_NAME:DATABASE_USERNAME:DATABASE_PASSWORD

replace DATABASE_NAME, DATABSE_USERNAME, DATABASE_PASSWORD with your intended values. like this localhost:5432:sheikh_alamoud_production:alamoud:1234samplePassword

to restart cron after modification use:

    sudo systemctl restart cron.service

to generate a cron command use: https://crontab-generator.org/

to restore database at certain time use this command:

    pg_restore -U alamoud -d sheikh_alamoud_production < /home/backups/NAME_OF_DATABASE_FILE

replace NAME_OF_DATABASE_FILE with the database file