yash244466666 / tNoteBook

iNoteBook

iNoteBook is a Full Stack Application where users can login and customize their notes with basic functions (add, delete, edit, update, etc.)

Installation Steps

See below for necessary installation of packages and dependencies

clone the project

git clone https://github.com/Luncy-May/iNoteBook.git 

create a package.json file in the root directory

npm init -y

install necessary dependencies for the backend

cd backend
npm install mongoose express

install necessary dependencies for frontend

cd frontend
npm install react-dom react-router-dom 

Run Locally

running the backend

#if you are not located in the backend
cd backend 
# run the server 
node index.js

running the frontend

#if you are not located in the frontend
cd frontend
# run the client-side  
npm start

Contributing

To contribute to this project, please follow these steps:

1. Fork the repository: Click the "Fork" button at the top-right corner of this page to create your own copy of the repository.
2. Clone the repository: Clone your forked repository to your local machine using the following command:

git clone https://github.com/Luncy-May/iNoteBook.git 

3. Create a new branch: Create a new branch for your contribution:

git checkout -b yourcreativename
# replace yourcreativename with the name you want to use

4. Commit changes: Commit your changes with a descriptive commit message:

git commit -am 'your description'
# replace your description with the your actual description

5. Push changes: Push your changes to your forked repository:

git push origin yourcreativename
#replace yourcreativename with the name you want to use

6. Submit a pull request: Go to the Pull Requests tab of the original repository and click on "New Pull Request". Fill out the necessary details and submit your pull request for review.
7. Wait for review: Your pull request will be reviewed by the project maintainers. Make sure to address any feedback or comments provided during the review process.
8. Celebrate: That's it! You are ready to go!

Coding Standards

• Use consistent indentation (e.g., tabs or spaces).
• Follow the existing code style and naming conventions.
• Write clear and concise code with comments where necessary.
• Ensure your code is well-tested and doesn't introduce any regressions.
• Any malicious messages or contents reflected is prohibited

Good Luck!