imksprateek / enotebook-cicd Goto Github PK

eNoteBook Readme

Introduction Welcome to eNoteBook! This project is a full-stack MERN (MongoDB, Express.js, React.js, Node.js) application designed to provide users with a platform to manage their notes. It includes authentication functionality, allowing users to sign up and log in securely.

Prerequisites Before running this project, ensure you have the following installed on your system:

Node.js (https://nodejs.org) MongoDB (https://www.mongodb.com/) Installation To run eNoteBook on your local machine, follow these steps:

Clone the repository:

bash Copy code git clone https://github.com/yourusername/eNoteBook.git Navigate to the project directory:

bash Copy code cd eNoteBook Install dependencies:

Copy code npm install Configuration Before running the project, you need to configure the MongoDB connection.

Create a .env file in the root directory of the project. Add the following lines to the .env file: makefile Copy code MONGODB_URI=your_mongodb_connection_string Running the Application Once the installation and configuration are complete, you can run the application using the following command:

arduino Copy code npm run both This command will start both the server and the React client concurrently.

Usage Sign Up: Navigate to the sign-up page and create a new account by providing your email and password. Log In: After signing up, log in using your email and password. Manage Notes: Once logged in, you can create, read, update, and delete your notes. Technologies Used MongoDB: NoSQL database for storing user information and notes. Express.js: Backend framework for handling HTTP requests and routes. React.js: Frontend library for building user interfaces. Node.js: JavaScript runtime environment for running server-side code. bcrypt: Library for hashing passwords securely. JWT (JSON Web Tokens): For authentication and authorization. Concurrently: For running multiple commands concurrently. Contributing Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

Fork the repository. Create your feature branch: git checkout -b feature/NewFeature Commit your changes: git commit -m 'Add some feature' Push to the branch: git push origin feature/NewFeature Submit a pull request. License This project is licensed under the MIT License. See the LICENSE file for details.

Contact If you have any questions or suggestions, feel free to contact us at [email protected].

Thank you for using eNoteBook! Happy note-taking! 📝✨