Skip to content

Coding Patterns

Casing

This codebase will be using camel casing.

Snake case with _id

You will sometime see some variables that ends with _id such as user_id. This is not a camel casing, but rather indicates that this is a MongoID reference.

Linters / Formatters

This will automatically format your code if you install ESLint in VS Code or type yarn lint in the specific folders.

Make sure you have installed the devDependencies so additional linters can be used.

Github Issues and Pull Requests

Most changes in the codebase can be matched to a github issue that contains description of the work that needs to be done. Each of the pull request are matched to this github issue with the branch name that has a standard a{Issue Number}-{branch name}. The issue number allows referencing especially when resolving reason for change.

Development with Docker

The development is done with Docker to orchestrate multiple services as defined in the docker-compose.yml file:

  • Mongo Database at localhost:27018
  • Database Administrator at localhost:27001
  • Client Side application at localhost:10015 (this is similar in deployment)
  • Server Side application at localhost:10016 (this is similar in deployment)
  • Documentation at localhost:8001