https://github.com/arijitcodes/demo-api-zeer
A Demo Todo List API with NodeJS, ExpressJS, AWS-SDK & DynamoDB [NodeJS] [Zeer]
https://github.com/arijitcodes/demo-api-zeer
api aws-sdk dotenv dynamodb express-validator expressjs helmet morgan nodejs nodejs-server nodemon rest-api todo todo-list todolist uuid
Last synced: 2 months ago
JSON representation
A Demo Todo List API with NodeJS, ExpressJS, AWS-SDK & DynamoDB [NodeJS] [Zeer]
- Host: GitHub
- URL: https://github.com/arijitcodes/demo-api-zeer
- Owner: arijitcodes
- Created: 2021-09-04T10:31:56.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-09-04T10:32:53.000Z (over 4 years ago)
- Last Synced: 2023-08-15T19:58:58.814Z (over 2 years ago)
- Topics: api, aws-sdk, dotenv, dynamodb, express-validator, expressjs, helmet, morgan, nodejs, nodejs-server, nodemon, rest-api, todo, todo-list, todolist, uuid
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Demo api with NodeJS, ExpressJS, AWS SDK & DynamoDB (Local)
`Author:` Arijit Banerjee
`Technologies Used:` NodeJS, ExpressJS, Express-Validator, UUID, Morgan, Helmet, Dotenv, AWS-SDK, DynamoDB
## Instruction:
#### To setup this API, follow the instructions carefully:
1. Rename the '.env.sample' file into '.env'.
2. Setup the .env variables in the .env file according to your DynamoDB Configuration.
3. After that, to setup the Database Tables automatically, run this following command in a terminal:
npm run setup-table
4. Now you can use the api accordingly.
NOTE: To delete the table after testing the api, run the following command:
npm run delete-table
## API Routes:
GET - `/api/todos` : Get all Todos from DB
GET - `/api/todos/:id` : Get one Todo item by ID
POST - `/api/todos` : Create/Post a New Todo item
PUT - `/api/todos/:id` : Update a Todo item
PATCH - `/api/todos/:id` : Change 'Completed' Status of a Todo item.
DELETE - `/api/todos/:id` : Delete a Todo item