my-notebook

Handy tool to make your notes
Explore the docs »

View Demo

About The Project

my-notebook is a web application that is used to keep your notes securly. Each user can create, edit and delete its own notes. It also authenticates the user before performing any CRUD operation.

Built With

• NodeJS
• ReactJS
• ExpressJS
• MongoDB

Preview

Live site

Link here

ScreenShots

SignUp Page

Login Page

Home Page

• Theme : Dark

• Theme : High Contrast

• Theme : Dark Teal

• Theme : Rainbow

Demo video

video

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Package.json file mentioned the requirements you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• Any code editor of your choice (VScode preferable )

Installation

1. Clone the repo

   git clone https://github.com/mohitm15/my-notebook.git

2. Install NPM packages and requirements

   npm install

Running the code

1. To run the frontend server , go to terminal and run

       cd frontend

   and then

       npm start

   The frontend server will run on localhost:/3000

2. To run the backend server , go to terminal and run

       cd backend

   and then

       npm start

   The backend server will run on localhost:/5000

Contributing

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Contact

Your Name -Mohit Maroliya

Project Link: https://github.com/mohitm15/my-notebook