->Description ->Features ->Tech Stack ->Installation ->Usage ->API Endpoints ->Contributing ->License ->Contact
Note++ is a React-based note-taking application where users can create, view, update, and delete their notes. The app features user authentication and stores data in a MongoDB database, utilizing Express for the backend API.
User authentication Create, read, update, and delete notes Responsive UI with React and Tailwind CSS Real-time updates using React hooks Error handling and notifications using React Toastify
Frontend: React, Tailwind CSS Backend: Node.js, Express Database: MongoDB Authentication: JWT Other Tools: React Toastify, react-icons, nodemon
Prerequisites Ensure you have the following installed on your system:
Node.js npm (Node Package Manager) MongoDB Steps Clone the repository
bash Copy code git clone https://github.com/your-username/note-plus-plus.git cd note-plus-plus Install backend dependencies
bash Copy code npm install Install frontend dependencies
bash Copy code cd frontend npm install cd .. Set up environment variables
Create a .env file in the root directory and add the following environment variables:
env Copy code PORT=5000 MONGO_DB_URL=your_mongodb_url NODE_ENV=development JWT_SECRET=your_jwt_secret Run the application
In the root directory, run:
bash Copy code npm run server This will start both the backend server (using nodemon) and the React development server.
Register and Login
Navigate to the registration or login page. Enter your credentials to create an account or log in. Create a Note
Click on the "Add Note" button. Fill in the title and content of your note. Submit the form to save the note. View Notes
All notes will be displayed on the main page after logging in. Notes are displayed with their title and content. Edit a Note
Click on the edit icon on a note. Update the title or content. Save changes. Delete a Note
Click on the delete icon on a note. Confirm deletion to remove the note.
User Routes POST /api/users/register: Register a new user POST /api/users/login: Authenticate a user and get a token Content Routes GET /api/content/ : Get all notes for a user POST /api/content/add: Create a new note PUT /api/content/update: Update an existing note POST /api/content/delete: Delete a note Contributing Contributions are welcome! Please follow these steps to contribute:
Fork the repository Create a new branch (git checkout -b feature-branch) Make your changes Commit your changes (git commit -m 'Add some feature') Push to the branch (git push origin feature-branch) Open a pull request
For any inquiries or feedback, please contact:
Name: Amal Varghese Email: [email protected] GitHub: code-wizard-2004