Skip to content

rmindit/frontend

Repository files navigation

rmindit frontend 🚀

rmindit is a project that helps users never miss upcoming contests by providing custom reminders. Stay up-to-date with all your favorite contests, analytics, notifications, and more.

Getting Started

Prerequisites

Make sure you have the following installed:

  • Node.js (LTS version recommended) (We recommend using NVM - Node Version Manager)
  • npm or yarn or pnpm or bun
  • A Supabase Account

Setup

  1. Clone the repository:

    git clone https://github.com/rmindit/frontend.git
    cd frontend
  2. Install the dependencies:

    npm install
    # or
    yarn install
    # or
    pnpm install
    # or
    bun install
  3. Create a .env.local file in the root of the project:

    cp .env.sample .env.local

    Add your environment variables inside .env.local as follows:

    NEXT_PUBLIC_SUPABASE_URL=<your-supabase-url>
    NEXT_PUBLIC_SUPABASE_ANON_KEY=<your-supabase-key>
    # Add more environment variables as needed
  4. Run the development server:

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev
  5. Open http://localhost:3000 with your browser to see the app.

Tools used

  • This project is build using Next.js
  • Supabase for database hosting & Auth
  • Tailwind CSS w/ shadcn components
  • This project uses Zustand for state management.

Learn More

To learn more about Next.js, check out the following resources:

Upcoming Features 🔥

  • Contest List: View a personalized list of upcoming contests, filtered by category, date, or platform, to ensure you never miss a competition.
  • Contest Analytics: Access detailed analytics on past and upcoming contests, including participation trends, contest difficulty, and performance statistics to help optimize your contest strategy.
  • Notification Logs: Keep track of all the contests you've been notified about, including the time of notification and your response, for a comprehensive history of reminders.
  • Custom Profiles with Badges: Create and customize your profile, earn badges for achievements such as contest participation streaks, top rankings, and more to showcase your contest history and milestones.
  • Dashboard Drag&Drop: Customize your dashboard by dragging and dropping widgets to rearrange the layout, prioritize information, and personalize your contest experience.
  • Calendar which shows upcoming events (https://originui.com/calendars-date-pickers)

Deployment

You can deploy this app easily using Vercel, the platform built by the creators of Next.js. For more information on deployment, check out the Next.js Deployment Documentation.

Releases

No releases published

Packages

No packages published