Skip to content

Commit

Permalink
more docs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nbogie committed Jan 27, 2024
1 parent 887f8fd commit ca0899d
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,28 @@ Run (for production with no live-reload)

`yarn start`

## Running tests

`yarn test`

## Linting

`yarn lint`

## Formatting with prettier

`yarn format`

However, it is suggested you install vscode's prettier extension and enable the user setting `format on save`. When formatting, VSCode will notice the .prettierrc and format according to those rules (and prettier's defaults).

## CI (linting, formatting check, automated tests)

This project includes a workflow file in [.github](.github) which will cause CI to run on github.

## Debugging with vscode

Set a breakpoint in the margin of any JS file, and use run-and-debug (ctrl-shift-d)'s `Run and Debug` button to start express. Bear in mind that a breakpoint set in a request handler won't cause express to pause until a matching request comes in!

## Getting started coding

- [Flavio Copes' Express Handbook](https://www.freecodecamp.org/news/the-express-handbook/)

0 comments on commit ca0899d

Please sign in to comment.