Skip to content

Micklitodev/NoteServer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NoteServer

Description

This project can be used to write, store, deleted and veiw notes, Threw server side rending and data persistance using the Express.js package.

Table of contents

Link

Click Here to go to the deployed link.

Screenshot

image

Installation

To install simply fork the repo, and clone down to your local machine. Then in the CLI at relative directory run 'npm i' to get all dependancies required for sucessfull run of the package.

Usage

To use the package you can click the button that says get started, you will be redirected to /notes route which will allow you to write a note by filling in both of the text areas, then clicking the save icon in the top right corner. To view the note taken you can click the note on the left hand side, which will show the note in the main area. To switch back to adding a note you can click the plus icon in the top right corner, finally to delete a note you can click the trash can beside the note which will remove the note and its data.

Contributions

How to contribute?: to contribute fork the repo and clone down to your local machine. Once you have the latest version of the repo you can add or make changes then submit a pull request for your changes. Please use best practices as well as proper naming conventions and comments depicting what the code segements function is. Finally in the body of your pull request please explain why these changes you were necissary and if it is a bug what steps can be completed to reproduce this bug. If these guidelines are not met, pull requests will not be reviewed or accepted.

Tests

Application endpoints were tested using Insomnia.

Questions

Github - Mick L. - https://github.com/micklitodev

Email - micklito.dev@gmail.com

When contact me please be mindful of timezones, Please check my profile for my current time information. Also, if it pertains to a bug, Please, use a clear, legible, instructions on how to recreate this bug as well as any videos or screenshots will be appriciated. Please also make the subject the specified project name with a short description of what the contact pertains to. Thank you!

License

MIT License

To see full details visit https://opensource.org/license/mit/

Preview...

  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.

About

Express.js, Node.js, JS, take notes with SSR application that uses data persistence.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published