/note

A minimalistic note taking app

Primary LanguageJavaScriptMIT LicenseMIT

License: MIT GitHub release (latest by date) GitHub repo size

This is note.

"note." is a minimalistic note taking app and also allows you (especially students) to keep track of your important assignments.

note-

Features

  1. You can create, update, view, delete and search your notes and assignments.
  2. You can use dark mode for better reading.
  3. Site is fully responsive so you can use it on any mobile device.

Tech stack

  • Nodejs
  • React
  • CSS3
  • HTML5
  • Express
  • MongoDB
  • CI/CD with Github Actions
  • Docker

Prequisites for development

  • Nodejs
  • Git

Commands

  1. Clone your forked repo on your local machine using command git clone https://github.com/{username}/note.git
  2. Run npm install in terminal to install all dependencies mentioned in package.json file.
  3. Also create a .env file in which you must add the server url. You can refer the .env.example file for it.
  4. Finally run npm run start script to start the app in dev mode. Open http://localhost:3000 to view it in your browser. The page will reload when you make changes.You may also see any lint errors in the console.

License

note is licensed under the MIT License - see the LICENSE file for details.