https://github.com/minusinfinite/simple-notes
A simple application to let you write down all those thoughts you have
https://github.com/minusinfinite/simple-notes
Last synced: about 1 year ago
JSON representation
A simple application to let you write down all those thoughts you have
- Host: GitHub
- URL: https://github.com/minusinfinite/simple-notes
- Owner: minusInfinite
- Created: 2021-08-18T10:57:01.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-21T11:12:42.000Z (almost 5 years ago)
- Last Synced: 2025-02-06T22:30:14.386Z (over 1 year ago)
- Language: JavaScript
- Size: 10.6 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Notes
A note taking application built with an Express backend for API calls
Deployment -
## Table of Contents
[Installation](#installation)
[Local Server](#local-server)
[API Documentation](#api-documentation)
[Examples](#examples)
[Credits](#credits)
## Installation
Clone the repo
```Shell
git clone https://github.com/minusInfinite/simple-notes.git
cd /simple-notes
```
This application uses the package manager Yarn - https://yarnpkg.com/
You may need to insure Yarn Classic is installed globally beforehand
```Shell
npm install -g yarn
yarn install
```
If there are any issues, you may need to just run `yarn install` again to setup the Plug and Play system correctly.
## Local Server
To start the local express server run one of the following scripts
```bash
yarn start //to start the server with node
yarn dev //to start the server with nodemon
```
## API Documentation
**METHOD**: GET
**ENDPOINF**: `/api/notes`
Get the current list of notes.
**METHOD**: POST
**ENDPOINF**: `/api/notes`
Post a new Note
**METHOD**: DELETE
**ENDPOINF**: `/api/notes/:note_id`
Delete a note via it's assigned ID.
## Examples
An example of the landing page
An example of the page Notes are written
## Credits
express - https://expressjs.com/
UUID - https://github.com/uuidjs/uuid