Skip to content

Commit

Permalink
(readme): last minute edits
Browse files Browse the repository at this point in the history
  • Loading branch information
salimdellali committed Nov 25, 2022
1 parent 3ce5bf9 commit 826c4c2
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ this project is an express server serving Mini Twitter REST API
- run `cp .env.example .env`
- copy environment variables inside the `.env` file
- if doing development:
- run `npm run start:dev`
- launch the server by running `npm run start:dev`
- if doing tests, run `npm run test:dev` to relaunch tests automatically after save
- if making it run on the production:
- if launching the server on the production:
- run `npm run build`
- run `npm start`
- to launch tests one time:
Expand All @@ -22,6 +22,10 @@ this project is an express server serving Mini Twitter REST API
- run `npm run prettier-format` to pretty the code
- run `npm run lint` to look for ESLint warnings and errors

## Swagger documentation

you can find the swagger documentation of the REST API by launching the server and hitting the endpoint `/api/v1/docs/`

## Project structure

- `src/`:
Expand All @@ -40,7 +44,7 @@ this project is an express server serving Mini Twitter REST API
- implement user module
- meanwhile testing the endpoints using postman
- implement auth module
- implementing tests for user module (and realizing I kind of suck at tests ':-) )
- implement tests for user module (and realizing I kind of suck at tests ':-) )
- implement tweet module
- linting the project ( because I realized I had ESLint disabled until the end of the project ':-) )
- write swagger documentation
Expand All @@ -52,7 +56,7 @@ this project is an express server serving Mini Twitter REST API
- Typescript
- Node.js
- Express.js
- MongoDB
- MongoDB ( already hosted on the cloud with MongoDB Atlass )
- Mongoose
- Json Web Tokens
- Bcrypt
Expand Down

0 comments on commit 826c4c2

Please sign in to comment.