🚀 This is a Next.js project bootstrapped with create-next-app.

🚧 Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

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

Open http://localhost:3000/api/v1/documentation with your browser to see the full documentation for all the routes. (build on top of the OpenAPI specification)

🤔 Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

🚀 Extra Libraries used

• @tanstack/react-query - Fetching data on the client
• @tanstack/react-table - Table component
• zod - Validation
• ShadCN - UI components
• better-auth - Authentication
• prisma - Database ORM
• pino - Logging
• scalar - Documentation

🚧 Commit Message Guidelines

This project follows a specific commit message format. Please use one of the following types:

• ci: Changes to CI configuration files and scripts
• chore: Maintenance tasks, such as updating dependencies or fixing code style
• docs: Changes to documentation
• ticket: Changes related to a specific ticket or issue
• feat: New features or functionality
• fix: Bug fixes
• perf: Performance improvements
• refactor: Code refactoring
• revert: Reverting previous changes
• style: Changes to code style or formatting

you wont be able to commit without a type, so make sure to add one.

🚨 Quirks

• To add new env variables, add them to the .env.example file and head over to @/lib/env.ts to add them to the EnvSchema. this will allow you to access them in your app in a type-safe manner.

Documentation

The ERD for this project can be found in the documentation/erd.md file.

The routes for this project can be found in the documentation/routes.md file.

Deployment

To deploy this project using Docker Compose, follow these steps:

1. Clone the repository:

git clone https://github.com/NHL-P2-INF2-DP/netflix-clone.git
cd netflix-clone

2. Copy the .env.example file to .env and update the environment variables as needed:

cp .env.example .env

3. Start the Docker containers:

docker-compose up

The application and the PostgreSQL database will now be running. The application will be accessible at http://localhost:3000.