https://github.com/hack-light/wejapa-week-1
https://github.com/hack-light/wejapa-week-1
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hack-light/wejapa-week-1
- Owner: Hack-Light
- Created: 2020-08-04T10:37:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T23:03:50.000Z (over 5 years ago)
- Last Synced: 2025-02-11T20:58:01.192Z (about 1 year ago)
- Language: JavaScript
- Size: 702 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# NOTE APP
## Setting up locally
1. Make Sure you have node and postman installed on your local machine
2. Clone this repository
3. CD into your clone repository
4. Run node sever.js
## Using Postman
### Creating a note
1. Send a POST request to localhost:3002
2. You need the following fields to be filled
- title - this will become the name of the file (Use a single word for this)
- category - this will be a directory that contains the file
- note - this is the content of the file
3. When you are done, inside the cloned directory you will see a Notes directory that houses the files sorted according to their categories(directory).
- This will automatically create a root folder called notes
### Display File Content
1. Send a GET request to localhost:3002/:category/:filename
- under the path variable section of the params tab fill
- category
- filename.txt
### Updating File content
1. Send a PUT request to localhost:3002/:category/:filename
- under the path variable section of the params tab fill
- category
- filename.txt
- under the Body of the params tab fill
- notes - this contains the text you want to add
### Deleting a file
1. Send a DELETE request to localhost:3002/:category/:filename
- under the path variable section of the params tab fill
- category
- filename.txt
# Summary
1. Send a GET request to localhost:3002/sumary