Welcome to Love Notes, a love-themed web application where you can manage your special moments, create to-do lists, post images, and add reminders for important dates.
- To-Do List: Create and manage your to-do lists and notes.
- Image Gallery: Post and view images in a shared gallery.
- Calendar: Add special dates and set reminders to never forget an important event.
- React: Frontend framework for building interactive UI.
- Tailwind CSS: Utility-first CSS framework for styling.
- Node.js: JavaScript runtime for backend logic.
- Express: Web framework for handling API requests.
- PostgreSQL: Database for storing notes, images, and calendar events.
- Git & GitHub: Version control and repository hosting.
- Heroku/Netlify/Vercel: For deployment (choose the service you’re using).
Make sure you have the following installed:
- Node.js (version 14 or higher)
- PostgreSQL (for database)
- npm (comes with Node.js) or yarn for package management
-
Clone the repository:
git clone https://github.com/yourusername/love-notes.git cd love-notes -
Install dependencies for the frontend:
cd frontend npm install -
Install dependencies for the backend:
cd ../backend npm install -
Set up your environment variables:
Create a
.envfile in thebackendfolder to store your database and server configurations:DATABASE_URL=your_postgres_database_url PORT=5000 -
Set up the PostgreSQL database: Create your PostgreSQL database locally or use a hosted service like Heroku or ElephantSQL. Update the
.envfile with the connection string. -
Run the backend server:
npm start
-
Run the frontend server:
cd ../frontend npm start
The app should now be running on http://localhost:3000 (frontend) and http://localhost:5000 (backend).
love-notes/
├── frontend/
│ ├── public/
│ ├── src/
│ │ ├── components/ # React components
│ │ ├── pages/ # Main pages (Notes, Gallery, Calendar)
│ │ └── App.js # Main React app
├── backend/
│ ├── config/ # Database connection setup
│ ├── controllers/ # API route handlers
│ ├── models/ # Database models (Notes, Images, Events)
│ ├── routes/ # Express routes for API
│ └── server.js # Main server file
└── README.md # Project documentation
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name
- Commit your changes:
git commit -m "feat: add your feature" - Push to the branch:
git push origin feature/your-feature-name
- Create a pull request on GitHub.
For more details, see the Contribution Guide.
- Add authentication for personalizing user content.
- Implement push notifications for reminders.
- Improve UI/UX with animations and transitions.
- Me: Thanks for contributing to this project!
- My girlfriend: Special thanks to my teammate for helping build this!
This project is licensed under the MIT License - see the LICENSE file for details.