This project is to develop api endpoints for a small company to manage their online api. This api will help frontend developers to build their frontend features to communicate with the backend database.
- Nodejs/Express
- PostgreSQL
- dotenv from npm for managing environment variables
- db-migrate from npm for migrations
- jsonwebtoken from npm for working with JWTs
- jasmine from npm for testing
- joi from npm for input validations
- bcrypt from npm for password hashing
- http-status-codes for response status codes
When this project is downloaded, install all packages and dependencies by running the command
npm install this will insall all the packages and dependencies in the package.json file.
Rename .env .example to .env and fill all values.
The port on which the development database runs is the value specified in .env as DEV_DB_PORT. Use the credentials DEV_DB_USER and DEV_DB_PASS specified in the .env file to login to the development database.
The port on which the testing database runs value specified in .env as TEST_DB_PORT. Use the credentials TEST_DB_USER and TEST_DB_PASS specified in the .env file to login to the test database.
If you use a local postgresql server on your machine, you will have to create two databases with the same names for the TEST_DB and DEV_DB values specified in the .env file with usernames and passwords matching TEST_DB_USER, TEST_DB_PASS for test and DEV_DB_USER, DEV_DB_PASS for development.
Start the server with any of the start scripts below. The server port is the value set DEV_SERVER_PORT when NODE_ENV is set to dev and TESTS_SERVER_PORT when NODE_ENV is set to test. If NODE_ENV is not specified, the server port defaults to 5000.
- Run the migration command to migrate the database.
T
- yarn / yarn install: install the required packages
- yarn run start: compile the code and start the server with javascript code
- yarn run devStart: start the server with typescript code
- yarn run watch: compile the code, launch the server with javacript code and watch for changes
- yarn run build / yarn run tsc: compile the typescript into javascript
- yarn run jasmine: run the tests
- yarn run test: compile the typescript and run the tests
- yarn run prettier: format the code
- yarn run lint: lint the code for errors
BASE ROUTE FOR API: /api
| ROUTE | VERB | ACTION | REQUIRES TOKEN |
|---|---|---|---|
| /auth/?password='admin password here' | GET | returns a token | |
| /users | GET | returns all users | True |
| /users/:id | GET | returns user with id | True |
| /users | POST | creates and returns a user | True |
| /categories | GET | returns all categories | |
| /categories | POST | creates and returns a category | |
| /products | GET | returns all products | |
| /products/:id | GET | returns product with id | |
| /products | POST | creates and returns a products | True |
| /products/categories/:category | GET | returns products with category | |
| /orders | POST | creates and returns an order or multiple orders | |
| /orders/complete-order | POST | completes and returns an order or multiple orders | |
| /orders/:userId/complete | GET | returns completed orders by userId | |
| /orders/:userId/active | GET | returns active orders by userId |