The Notebook Website is a MERN stack project that allows users to upload, delete, and update their personal notes, as well as search for notes by the title. It provides a user-friendly interface using Bootstrap for styling. The project utilizes the following technologies:
- React: A JavaScript library for building user interfaces.
- React Router: A routing library for managing navigation within the application.
- MongoDB: A NoSQL database for storing note data.
- Express.js: A web application framework for building the backend API.
- Node.js: A JavaScript runtime environment for server-side development.
- JSON Web Tokens (JWT): A token-based authentication mechanism for securing user access.
- bcryptjs: A library for encrypting and decrypting user data.
Check out the live demo of the website: Notebook Website
To run the website locally, follow these steps:
- Clone the repository:
https://github.com/SomnathKar000/Notebook
- Navigate to the Backend directory:
cd Backend
- Install Backend dependencies:
npm install
- Return to the root directory:
cd ..
- Install root directory dependencies:
npm install
Make sure to set up the following environment variables:
- Create a
.env
file in the root directory of the project. - Define the following environment variables in the
.env
file:DB_URI=<your-mongodb-uri>
: The MongoDB connection URIJWT_SECRET=<your-jwt-secret>
: The secret key used for JWT authentication
- Start both servers:
npm run both
- Open the application in your browser:
http://localhost:3000
Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Add your message here'
- Push to the branch:
git push origin feature/your-feature-name
- Open a pull request
Please make sure to run tests before submitting your pull request and adhere to the code style guidelines.
For more information or questions, feel free to reach out:
- Email: [email protected]
- LinkedIn: Somnath Kar
- GitHub: SomnathKar000