This is backend API for gosky web and android application as a part of fullstack web and android development course final project.
This application is currently deployed using railway.app.
You can access this application on https://gosky.up.railway.app/
Information about server routes and documentation can be seen here.
To run this application in your computer you can follow these steps below.
npm install
Run this command to install all dependencies needed by this project.
npm run db:setup
After that, run this command to setup database with sequelize. Remember to setup .env file on this project first with your postgres database, cloudinary, and email data. You can follow this example file here. Remember to have your postgres database installed and running.
npm start
run this command to start express server normally. To run the server in development mode, use this command instead:
npm run develop
To run both unit tests, use this command:
npm test
Documentation about API is available here:
| Route | Default Local Link | Live Link |
|---|---|---|
/documentation |
localhost:8000/docs | https://gosky.up.railway.app/docs/ |
Default admin account data is available and can be changed in local on config/admin.js with this as default settings:
{
name: 'admin',
email: 'gosky.admin@gmail.com',
password: 'admin',
}
Unit and integration tests coverage of this project is >98%, details can be seen on this image below.
