EasyNote

Welcome to the Notes App repository! This is a web application built using Next.js on the frontend and NestJS on the backend that allows users to create and manage notes. The app utilizes JWT for authentication, Recoil for state management, Axios for API communication, and Tailwind CSS for styling.

Table of Contents

• Screenshots
• Features
• Technologies Used
• Installation
• Deployment
• Contributing
• Contact

Screenshots

Features

• User authentication and registration.
• Users can create and manage notes.

Technologies Used

• Frontend:

  • Next.js for building the user interface.
  • Tailwind CSS for styling components.
  • Recoil for state management.

• Backend:

  • Nest.js for server-side logic.
  • MongoDB for the database.
  • JSON Web Tokens (JWT) for authentication.

Installation

1. Clone the repository:

git clone https://github.com/nipun-mehndiratta/easyNote.git

2. Navigate to the project directory:

cd easynote

3. Install backend dependencies:

cd notes-backend && npm install

4. Install frontend dependencies:

cd notes && npm install

5. Make sure to update the MongoDB connection details in the notes-backend/.env file.

6. Start the backend server:

In the server directory, run: npm run start

7. Start the Frontend:

In the notes directory, run: npm run dev

Deployment

The frontend/Next.js application has been deployed on Netlify, while the backend is hosted on a server provided by Render.com.

Contributing

Contributions are welcome! To contribute to this project, follow these steps:

1. Fork the repository.
2. Create a new branch for your feature: git checkout -b feature-name
3. Make your changes and commit them: git commit -m "Add some feature"
4. Push the changes to your fork: git push origin feature-name
5. Create a pull request detailing your changes.

Contact

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