https://github.com/gaitherdb/note-taker
An application that allows a user to write, save, delete, and view notes. The application is hosted by Heroku.
https://github.com/gaitherdb/note-taker
dbjson expressjs heroku-deployment restful-api
Last synced: 2 months ago
JSON representation
An application that allows a user to write, save, delete, and view notes. The application is hosted by Heroku.
- Host: GitHub
- URL: https://github.com/gaitherdb/note-taker
- Owner: Gaitherdb
- Created: 2021-08-12T21:09:34.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-17T20:47:57.000Z (almost 4 years ago)
- Last Synced: 2025-01-31T12:12:58.313Z (4 months ago)
- Topics: dbjson, expressjs, heroku-deployment, restful-api
- 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
# Note Taker
## 
## Description
An application that allows a user to write, save, delete, and view notes. The application is hosted by Heroku and is therefore always running. The note texts are saved to a database which lives on Heroku's server. This means that anyone who accesses the deployed application will be able to edit the same database and interact with the same notes.
Here is the deployed URL: [Note Taker](https://arcane-inlet-18974.herokuapp.com/). The base url takes you to the default paramater, which is the homepage to get started. Click on the button and you will be redirected to the `https://arcane-inlet-18974.herokuapp.com/notes`. To view the API from the database, enter `https://arcane-inlet-18974.herokuapp.com/api/notes`. Any additional parameters will redirect you to the homepage.
While creating this app, I used Node.js and Express.js to host a local server, which allowed my front-end to work with my back-end database. The front-end javascript fetches a GET, POST, or DELETE from my back-end files, which interacts with the database.
Installation and Usage sections pertain to running the local server. If you want to use a deployed version of the app, use the heroku url.
## Table of Contents
* [Installation](#installation)
* [Usage](#usage)
* [License](#license)
* [Contributing](#contributing)
* [Tests](#tests)
* [Questions](#questions)
## Installation
To install Node.js, follow the documentation [Node.js](https://coding-boot-camp.github.io/full-stack/nodejs/how-to-install-nodejs)
To install necessary dependencies for your local server, run the following command:
```
npm i
```
## Usage
Set the path to the Note-Taker folder in the terminal, run the server.js file by typing `node server.js`. Access the local url at `http://localhost:3001` and try adding, saving, or deleting a note. Notice these changes appear in the db.json file.
## License
This project is licensed under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Contributing
I am the sole author of this repo and I am not currently looking for contributors.
## Questions
If you have any questions about the repo, open an issue or contact me directly at [email protected]. You can find more of my work at [Gaitherdb](https://github.com/Gaitherdb).