Purple Books API

TODO

• Enable Logging
• Error Handling
• Routes
• Use Docker for testing
• Postgres as Database
• Deploying on Digital Ocean

Pre-Requisites

• Node
• A Running Postgres Connection

Running the API

• Clone this repository in a folder of your choice. (use ssh if you want)

  git clone https://github.com/Purple-books-company/purple-books-API.git

• Move into the project folder

  cd purple-books-API

• Create .env file in the root of the project. (use .env.example as a template)

• Install App Dependencies

  npm ci

• Start the App.

  • with Nodemon

    npm run dev

  • without Nodemon

    npm start

How to Contribute

• Make sure you are on master branch.

  git checkout master

• Fetch the latest commits

  git fetch origin

• Reset Local repo to match the Origin repo

  git reset --hard origin/master

• Make a new feature branch. (you cannot directly push to master branch)

  git checkout -b <your-name>/<feature-name>

  Example

  git checkout -b mugilan/login

• Make and Commit the changes

  git status
  git add <file-name>
  git commit -m "<some-meaningfull-commit-message>"

• Push the changes to remote to make a Pull Request(PR).

  git push -u <your-name>/<feature-name>

• Make a Pull Request(PR) in github and wait for approval.

• Delete Local Branches after successfull PR approval. (optional)

  git branch -d <your-name>/<feature-name>

• Sync with the remote branches by pruning deleted remote branches

  git fetch -p