The Blog app example, contains JWT Auth and Mongoose ODM for MongoDB.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
- Node - The web server
- Yarn - Package Manager
- MongoDB - Database
- Postman or Insomnia - API Testing Tool
A step by step series of examples that tell you how to get a development env running, Say what the step will be :
- Copy and rename
.env.exampleto.envand configure your enviroment - Run
$ yarn - Run
$ yarn build:watch - RUn
$ yarn dev - Open Postman/ Insomnia to test API
The Route User Manajemen & Auth :
| Method | EndPoint | Description |
|---|---|---|
| POST | /api/v1/auth/signin | User Auth |
| POST | /api/v1/auth/signup | User Register |
| GET | /api/v1/user/Profile | User Profile |
The Route Topic Manajemen :
| Method | EndPoint | Description |
|---|---|---|
| GET | /api/v1/topics | Show All Topics |
| POST | /api/v1/topics | Store New Topic |
| GET | /api/v1/topics/:id | Show Topic |
| PUT | /api/v1/topics/:id | Update Topic |
| DELETE | /api/v1/topics/:id | Delete Topic |
The Route Article Manajemen :
| Method | EndPoint | Description |
|---|---|---|
| GET | /api/v1/articles | Show All Articles |
| POST | /api/v1/articles | Store New Article |
| GET | /api/v1/articles/:id | Show Article |
| PUT | /api/v1/articles/:id | Update Article |
| DELETE | /api/v1/articles/:id | Delete Article |
| Filter | ?filter_field | Field filter, ex: status |
| Filter | ?filter_value | Value filter, ex: draft, deleted, published |
| Filter | ?topic | Topic filter, ex: sci-fi, crime, adventure |
| Sort | ?sort_field | Sort field, ex: title, createdBy |
| Sort | ?sort_orientation | Sort orientation, ex: asc & desc |
- Sebastianus Sembara - Initial work - ssembara
See also the list of contributors who participated in this project.