https://github.com/santthosh/todoist
Easy to manage tasks and reminders
https://github.com/santthosh/todoist
cursor nextjs postgresql redis todolist vibe vibecoding
Last synced: 6 months ago
JSON representation
Easy to manage tasks and reminders
- Host: GitHub
- URL: https://github.com/santthosh/todoist
- Owner: santthosh
- License: mit
- Created: 2025-03-12T00:27:59.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-13T04:17:55.000Z (7 months ago)
- Last Synced: 2025-03-23T21:39:07.775Z (7 months ago)
- Topics: cursor, nextjs, postgresql, redis, todolist, vibe, vibecoding
- Language: TypeScript
- Homepage: https://todoist.cloud
- Size: 408 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# todoist.cloud
**Easy to manage tasks and reminders**
[](https://github.com/santthosh/todoist/actions/workflows/test.yml)
[](https://nextjs.org/)
[](https://www.typescriptlang.org/)
[](https://tailwindcss.com/)
[](https://flowbite.com/)
[](https://www.postgresql.org/)
[](https://redis.io/)
[](https://jestjs.io/)
[](https://opensource.org/licenses/MIT)
## Features
This application is a full-featured task management application that allows you to:
- Create multiple task lists to organize your activities
- Add items to your lists
- Mark items as complete
- Set due dates for your tasks
- Schedule reminders for important tasks
- Archive lists you no longer need
- Delete lists and items
The application uses PostgreSQL for data storage and Redis for caching reminders.
## Live Demo
Check out the live application at [https://todoist.cloud](https://todoist.cloud)
## Getting Started
First, run the development server:
```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Local Development with Docker Compose
This project uses PostgreSQL and Redis for data storage. To simplify local development, a Docker Compose configuration is provided.
### Prerequisites
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/) (usually included with Docker Desktop)
### Starting the Database Services
1. Start PostgreSQL and Redis containers:
```bash
docker-compose up -d
```
2. The services will be available at:
- PostgreSQL: `localhost:5432` (User: todoist, Password: aIU0Ys5hrBPho647FLBpzl+Q37IM5mQhTgUhTqt25mE=, Database: todoist)
- Redis: `localhost:6379`
3. Update your `.env` file to connect to these services:
```
DATABASE_URL="postgresql://todoist:aIU0Ys5hrBPho647FLBpzl+Q37IM5mQhTgUhTqt25mE=@localhost:5432/todoist?schema=public"
REDIS_URL="redis://localhost:6379"
```
4. Run database migrations:
```bash
npx prisma migrate dev
```
### Stopping the Services
To stop the containers:
```bash
docker-compose down
```
To stop and remove all data volumes:
```bash
docker-compose down -v
```
## Testing
This project includes comprehensive unit tests for components and API routes. The tests are written using Jest and React Testing Library.
### Test Structure
- `src/__tests__/components/` - Tests for React components
- `src/__tests__/api/` - Tests for API routes
- `src/__tests__/utils/` - Tests for utility functions
- `e2e-tests/` - End-to-end tests using Playwright
### Running Tests
To run the unit tests:
```bash
npm test
```
To run tests in watch mode (useful during development):
```bash
npm run test:watch
```
To run end-to-end tests with Playwright:
```bash
npm run test:e2e
```
To run end-to-end tests with UI mode (for debugging):
```bash
npm run test:e2e:ui
```
To view the Playwright test report:
```bash
npm run test:e2e:report
```
### E2E Test Coverage
The end-to-end tests cover the following functionality:
- **Home Page**: Verifies that the home page loads correctly and displays the expected UI elements.
- **Todo List Creation**: Tests the creation of new todo lists.
- **Responsive Design**: Ensures the application works correctly on different screen sizes.
- **Theme Switching**: Verifies that the dark/light mode toggle works correctly.
Some tests are currently skipped due to limitations in the test environment:
- Tests that require navigating to list detail pages
- Tests for reminders functionality
### Continuous Integration
This project uses GitHub Actions for continuous integration. Tests are automatically run when:
- Code is pushed to the `main` branch
- A pull request is created targeting the `main` branch
The workflow sets up a test environment with Node.js, PostgreSQL, and Redis to ensure all tests pass in an environment similar to production.
Additionally, end-to-end tests are run after successful deployment to verify the application is working correctly in production.
To see the status of the latest test runs, check the "Actions" tab in the GitHub repository.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
This project is deployed at [https://todoist.cloud](https://todoist.cloud) using Vercel's platform.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
## Contributing
Contributions are welcome! Here's how you can contribute to this project:
### Code of Conduct
Please be respectful and inclusive when contributing to this project. Harassment or abusive behavior will not be tolerated.
### How to Contribute
1. **Fork the repository** - Create your own copy of the project to work on.
2. **Create a branch** - Make your changes in a new branch (`git checkout -b feature/amazing-feature`).
3. **Make your changes** - Implement your feature or bug fix.
4. **Run tests** - Ensure all tests pass with `npm test`.
5. **Commit your changes** - Use clear commit messages that explain what you've done.
6. **Push to your branch** - Upload your changes to your forked repository.
7. **Create a Pull Request** - Submit a PR to the main repository for review.
### Pull Request Guidelines
- Ensure your code passes all tests
- Update documentation as needed
- Include screenshots or examples if relevant
- Keep PRs focused on a single feature or fix
### Development Setup
Follow the "Getting Started" and "Local Development with Docker Compose" sections above to set up your development environment.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Continuous Integration and Deployment (CI/CD)
This project uses GitHub Actions for continuous integration and deployment to Vercel. The workflow is configured to:
1. Run all tests when code is pushed to the `main` branch or when a pull request is created
2. Automatically deploy to Vercel when tests pass on the `main` branch
### CI/CD Workflow
The CI/CD pipeline consists of two main jobs:
1. **Test**: Runs all tests to ensure code quality
2. **Deploy**: Deploys the application to Vercel if all tests pass (only on the `main` branch)
### Setting Up Vercel Deployment
To set up automatic deployment to Vercel, you need to add the following secrets to your GitHub repository:
- `VERCEL_TOKEN`: Your Vercel API token
- `VERCEL_ORG_ID`: Your Vercel organization ID
- `VERCEL_PROJECT_ID`: Your Vercel project ID
You can find these values in your Vercel project settings.
### Deployment Configuration
The deployment configuration is defined in the following files:
- `.github/workflows/ci-cd.yml`: The main CI/CD workflow using Vercel CLI
- `.github/workflows/vercel-deploy.yml`: An alternative workflow using the official Vercel GitHub Action
- `vercel.json`: Configuration for Vercel deployment
You can choose which workflow to use based on your preferences. The `ci-cd.yml` workflow provides more control over the deployment process, while the `vercel-deploy.yml` workflow is simpler and uses the official Vercel GitHub Action.
## Deployment
### Prisma Setup for Deployment
The application is configured to work with Prisma in both development and production environments. The following configurations have been made:
1. **Binary Targets**: The Prisma schema includes binary targets for both local development (`native`) and RHEL-based production environments (`rhel-openssl-3.0.x`).
2. **Build Process**: The build process includes Prisma client generation and database migrations:
```
prisma generate && prisma migrate deploy && next build
```
3. **CI/CD Pipeline**: The GitHub Actions workflow is configured to:
- Generate the Prisma client during testing
- Run database migrations during deployment
- Pass the necessary environment variables to the build process
4. **Environment Variables**: Make sure to set the following environment variables in your Vercel project:
- `DATABASE_URL`: The connection string for your PostgreSQL database
- `REDIS_URL`: The connection string for your Redis instance
5. **GitHub Secrets**: The following secrets should be set in your GitHub repository:
- `VERCEL_TOKEN`: Your Vercel API token
- `VERCEL_ORG_ID`: Your Vercel organization ID
- `VERCEL_PROJECT_ID`: Your Vercel project ID
- `DATABASE_URL`: The connection string for your PostgreSQL database
- `REDIS_URL`: The connection string for your Redis instance
