This is a note taking application with its backend built out using express.js.
To install the application locally
- Clone the Repo into your local machine. The Repository can be found here
- Run
npm install
in the same directory as the package.json - This command should install express and enable you to run the server on PORT 8080.
You can run the application one of two ways:
-
Going to the deployed application, which can be found at this link.
-
Once the application's files and dependencies have been installed to the local machine, you can run start the server by running
npm start
, or alternatively,node server.js
.- This should start the server on PORT 8080 of localhost.
-
Once the server has been started, you venture to the application by going to the deployed application or by going to http://localhost:8080 in your web browser of choice.
-
When you go to the deployed application, you will be greeted with the following view:
-
Next, Click on the "Get Started" button. It should take you to the next page, which should look like this if there are notes:
-
Or it should look like this if there are no notes at the moment:
.
-
By clicking on the pencil icon, you will be able to add a new note. You Will Then be able to save the note by clicking the save icon:
-
By Clicking on a note on the left, you will be able to view its entirety in the active notes section to the right:
My Github is found at the following link
You can contact me via email at bpeteradams@gmail.com
Contribute by viewing and forking the repo.
MIT License
Copyright (c) 2021 Brian P. Adams
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.