We will be building an API for the purpose of accessing application data programmatically. The intention here is to mimic the building of a real world backend service (such as reddit) which should provide this information to the front end architecture.

Your database will be PSQL, and you will interact with it using node-postgres.

To keep track of the tasks involved in this project we're going to use a kanban board. Ensure that you work on one ticket at time. You can click on the ticket to find out more information about what is required for the feature. A ticket is not considered complete unless both the happy path and errors response are handled. You can make use of the checklist on each ticket to keep track of the errors you want to handle. You can also make use of error-handling.md to consider the error codes we may wish to respond with.

Please ensure you work through the tickets in numerical order.

You will be working on each ticket on a new branch.

To create and switch to a new git branch use the command:

git checkout -b <new branch name>

This will create a branch and move over to that branch. (Omit the -b flag if you wish to switch to an already existing branch).

We recommend that you name the branch after the number assigned to each ticket via the header. eg. ncnews-1

When pushing the branch to git hub ensure that you make reference to the branch you are pushing to on the remote.

git push origin <branch name>

From github you can make a pull request and share the link and ticket number via a pull request specific nchelp using the command nchelp pr. A tutor will swing by to review your code. Ensure that you keep your trello up to date whilst you await the PR approval. Regular nchelp will be available for when you need support.

Once a pull request been accepted be sure to switch back to the main branch and pull down the updated changes.

git checkout main

git pull origin main

You can tidy up your local branches once they have been pull into main by deleting them:

git branch -D <local branch>

To ensure we are not commiting broken code this project makes use of git hooks. Git hooks are scripts triggered during certain events in the git lifecycle. Husky is a popular package which allows us to set up and maintain these scripts. This project makes use a pre-commit hook. When we attempt to commit our work, the script defined in the pre-commit file will run. If any of our tests fail than the commit will be aborted.

The Husky documentation explains how to configure Husky for your own project as well as creating your own custom hooks._