Notebook

Description

This is about Notebook:

            Using Notebook you could- <br>1. Write your personal / proffesional notes<br>2. Secure your notes on clould<br>3. Access your notes from anywhere from any devices<br>4. Edit or Delete your notes <br>5. Give your notes a perticular tag <br>6. Maintaine privacy using credentials

Features

1. Here notebook is created using React as a frontend and NodeJS as a backend.
2. Here you can add , delete and update notes in your Mongoose database.
3. You create a password using express validation , authentication using JWT Token and salting.
4. An easy way to sign up and log in a notebook, context for data passing through the component.

File Structure

Project Root
|
|- frontend
|  |- src/
|  |- public/
|
|- middleware
|- Models
|- routes
|- database.js
|- index.js
|- package.json
|- README.md
|- .gitignore

Step to run this project:

Step 1. Add .env file

Format of .env file

PORT: 5000
MONGO_URL = YOUR_MONGO_URL
NODE_ENV = production
SECRET_KEY= Your_Secret

Step 2. Install Dependencies in Frontend folder

CODE -- npm install

Step 3. Install Dependencies in Root folder

CODE -- npm install

Step 4. Run This Project from Root folder

CODE -- npm run dev

How to Start Contributing

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.
Open a terminal and run the following git command:
```
  git clone "url you just copied"
```
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. For example:
```
  git clone https://github.com/your_username/NoteBook.git
```
Now create a branch using the 'git switch' command in repository directory:
```
  git switch -c your-new-branch-name
```
Make necessary changes and commit those changes. Add those changes to the branch you just created using the 'git add' command:
```
  git add .
```
Now commit those changes using the 'git commit' command:
```
  git commit -m "Add your title here"
```
Push your changes using the command git push:
```
  git push -u origin your-branch-name
```
replacing your-branch-name with the name of the branch you created earlier.
Submit your changes for review If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button. Now add appropriate title and comment on it and submit the pull request.

Rajat2024 / NoteBook

readme