Rental Management System (Project group 3 Fall 2022)
Featuring Docker, Node, Express, Postgres, Sequelize, & NGINX
TODO – Add FE setup to docker
About
This configuration is a backend RESTful API code with the following pieces:
- Docker as the container service to isolate the environment.
- Node.js (Long-Term-Support Version) as the run-time environment to run JavaScript.
- Express.js as the server framework / controller layer
- Postgres as the database layer
- Sequelize as the “ODM” / model layer
- NGINX as a proxy / content-caching layer
How to Install & Run
You will need to first download and install Docker Desktop or Linux equivalent.
- Fork/Clone the repo
- Run
docker-compose --env-file .env.be.dev build
to build the containers - Run
docker-compose --env-file .env.be.dev up
to start three containers:- the Postgres database container
- the Node.js app container
- the NGINX proxy container
- Server is accessible at
http://localhost:8080
if you have Docker for Windows or Mac. Usehttp://localhost
without specifying the port to hit the NGINX proxy. On Linux, you may need to hit the IP Address of the docker-machine rather thanlocalhost
(port rules are the same.)
How to Run Tests
Currently, tests are run outside of the Docker container (unfortunately for now).
TODO
Create test DB. You should be able to run npm install
followed by npm test
to run everything (assuming you have the LTS version of Node installed on your machine).
App Structure
- the boilerplate entity is called “Thing” and all the routes are based on the thing resource. When you want to start building a real API, you can probably just do a global find and replace for thing, but mind the case-sensitivity.
- most folders have an
index.js
which simply exports the contents of all the files in those folders. This is to make importing things around the app slightly easier, since you can justrequire
the folder name and destructure the functions you are looking for. Check out this part of the Node.js docs for more info.
__tests__
- this folder contains unit and integration tests both run using
npm test
which in turn uses Jest
./app
handlers
are Express.js route handlers that haverequest
,response
, andnext
parameters.helpers
are raw JS “classes” and utility functions for use across the appmodels
are Sequelize schema definitions and associated modelsrouters
are RESTful route declarations using express.Router module that utilize the functions inhandlers
schemas
are JSONSchema validation schemas for creating or updating a Thing. Pro-tip: use JSONSchema.net to generate schemas based on examples for you.app.js
is what builds and configures the express appconfig.js
is the app-specific config that you will want to customize for your appindex.js
is the entrypoint that actually starts the Express server
./config
- config contains NGINX proxy configuration, the production pm2 configuration (the process-runner of choice),
TODO
Add Jest configuration to run Postgres in memory
Add https in ngix proxy for google login