A feature-rich application for managing notes with authentication, a customizable interface, and a responsive design.
- Custom User Authentication: Secure authentication with password management.
- User Account Management: Create and manage user accounts.
- CRUD Operations: Add, edit, delete, and view notes.
- Light/Dark Theme: Toggle between light and dark themes.
- Responsive Design: Optimized for various screen sizes.
- Extendable UI: Built with shadcn/ui.
- Routing: Seamless navigation using
react-router-dom
.
Before setting up the application, ensure you have the following:
- MongoDB Connection URL: A running MongoDB instance.
- Node.js: Installed on your system.
- Yarn: For dependency management (optional, you can use npm if preferred).
Follow these steps to set up the application locally:
- Navigate to the
server
directory and copy the environment example file:cd server && cp .env.example .env
- Update the
.env
file with your credentials:JWT_SECRET="your-secret-key" MONGO_URL="mongodb://localhost:27017/noteapp" CLIENT_URL="http://localhost:4173"
- Start the backend server:
yarn start
- Navigate to the
client
directory and copy the environment example file:cd client && cp .env.example .env
- Update the
.env
file with your API URL:VITE_API_URL=http://localhost:3000/api
- Start the frontend application:
yarn preview
Once both the backend and frontend are set up and running:
- Open your browser and navigate to
http://localhost:4173
. - Create an account, log in, and start managing your notes!
- Ensure MongoDB is running before starting the backend server.
- Use
yarn
ornpm
consistently for dependency management. - For production deployments, make sure to replace development URLs and secrets with production-ready values.
Happy coding!