Chorely

Set up household (or team) chores, and once a task is marked complete, automatically transfer the payment to the assigned person’s account.

Note: This project is in the early stages of development. More features and information will be added soon.

Getting Started

Prerequisites

• Node.js
• npm (or Yarn)
• PostgreSQL

Installation and Setup

1. Clone the repository:

   git clone https://github.com/your-username/chorely.git

2. Install dependencies:

   npm install

3. Set up your environment variables by creating a .env file in the root of the project and adding the following:

   DATABASE_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE"
   DIRECT_URL="postgresql://USER:PASSWORD@HOST:PORT/DATABASE"
   

4. Run the database migrations:

   npx prisma migrate dev

5. (Optional) Seed the database with sample data:

   npm run prisma-seed

Running the Development Server

npm run dev

Open http://localhost:3000 with your browser to see the result.

Technologies Used

• Framework: Next.js
• Language: TypeScript
• Database: PostgreSQL with Prisma
• Styling: Tailwind CSS
• UI Components: Radix UI
• Testing: Vitest, React Testing Library, and Playwright
• Linting & Formatting: ESLint and Prettier

Available Scripts

• dev: Runs the development server.
• build: Creates a production build.
• start: Starts the production server.
• lint: Lints the codebase.
• lint-fix: Lints and fixes the codebase.
• test: Runs unit and component tests.
• test:e2e: Runs end-to-end tests.