pheralb/reminder

Explore
  ❖  
Roadmap
  ❖  
Contribute/Self Hosted
  ❖  
Create issue
  ❖  
X/Twitter

✨ Introduction

Reminder is a minimalist and intuitive to-do list app that helps you stay organized without distractions. Easily create organizations, group tasks into collections, and set reminders — all for free.

Designed with a clean and minimal interface and a smart structure, Reminder is perfect for creators, professionals, and anyone looking to get things done.

🚀 Getting Started

To run this project locally, follow these steps:

1. Clone or fork the repository:

git clone git@github.com:pheralb/reminder.git

2. Navigate to the project directory:

cd reminder

3. Install the dependencies:

# Install pnpm if you don't have it:
npm install -g pnpm

# Install the dependencies:
pnpm install

4. Create a .env file in the root directory and add your environment variables:

• DATABASE_URL: Your PostgreSQL database URL. You can use Railway or Neon to create a free PostgreSQL database.
• CLERK_SECRET_KEY & NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: Your Clerk secret key. You can create a free account on Clerk and get your secret key from the dashboard.
• NEXT_PUBLIC_CLERK_**_URL: The URL to redirect users after sign-in and sign-up.

# DATABASE URL:
DATABASE_URL=""

# CLERK:
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=
NEXT_PUBLIC_CLERK_SIGN_IN_FALLBACK_REDIRECT_URL=
NEXT_PUBLIC_CLERK_SIGN_UP_FALLBACK_REDIRECT_URL=

5. Push the reminder_ tables to your database:

pnpm db push

6. Start the development server:

pnpm dev

Ready 🚀

🔭 Roadmap

Global

• Refactor forms. Use one only form for create and update (working).
• Improve UI/UX for mobile devices.
• Improve Metadata, add OG Image.

Organizations

• Get a list of organizations.
• Insert a new organization.
• Delete an organization.
• Update an organization.
• Go to organization page.

Collections

• Get a list of collections.
• Insert a new collection.
• Delete a collection.
• Update a collection.

Reminders

• Get a list of reminders in a collection.
• Insert a new reminders in a collection.
• Update an reminders in a collection.

📦 Stack

This project is built with the T3 Stack and uses the following technologies:

• Next.js - The React framework for production.
• Clerk - Authentication and user management.
• Drizzle - TypeScript ORM for PostgreSQL.
• PostgreSQL - The world's most advanced open source relational database.
• Tailwind CSS - A utility-first CSS framework for rapid UI development.
• shadcn/ui - A set of components built with Tailwind CSS and Radix UI.
• Tanstack Query - A powerful data-fetching library for React.
• Zod - A TypeScript-first schema declaration and validation library.

📜 License

This project is licensed under the Apache 2.0 License.