Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.14 KB

README.md

File metadata and controls

55 lines (37 loc) · 2.14 KB

Notes

This is a webapp for managing notes. It is a simple webapp that allows you to create, edit, group, and delete notes. You can use the live version(It's totally free to use with no ads and I will keep it that way for as long as I can), or you can host your own webapp locally or on a server while storing your notes safely on a remote deta server (See the Installation instructions below).

Feel free to reach out with any bug reports, feature requests or suggestions for better user experience.

Live:

https://notes.aryalaabishkar.com.np

Tech Stack:

Installation:

  1. Clone the git repository.
    git clone https://github.com/aabishkaryal/notes
  2. Go to the project directory.
    cd notes
  3. Create an .env file, look at .env.example for reference.
  4. Install dependencies.
    yarn install
  5. Build the project.
    yarn build
  6. Run the server.
    yarn start

Features:

  • Light and Dark Mode Support
  • Live Preview Support
  • Free forever
  • Markdown support
  • Mobile friendly

TODOs:

  • Add auth features (password recovery, email authentication and so on.)
  • Add tag support
  • Add search bar

Motivation:

Taking notes as a developer is a huge part of learning that seems to be neglected by the community in general. Yes I'm not an expert nor a 10x developer but rm I've found taking notes to be very helpful. Normally, I scribble stuff on my copy and it has worked great for me. But I want to take it a step further and have it stored digitally. Then I went on a search for apps with markdown note support but couldn't find one that was good enough for me. So, I decided to create my own. I know this is not perfect in any sense of the word but given the knowledge I have at this point in time, I am pretty satisfied with myself. I will be adding features as I get some free time (some stars would be great too.)

Feedback:

If you have any feedback, create an issue or reach out to me at aabishkaryal@gmail.com

License:

MIT