Setup

Prerequisites

• This project is set up to run within a Docker environment.
• Ensure Docker and Docker Compose are installed on your machine. -This project is primarily developed on WSL2 (Ubuntu). We have not tested it on other environments.

Setup Instructions

1. Clone the repository:

   git clone https://github.com/shimauma0312/TaNaRi-Chan.git
   cd TaNaRi-Chan
   

2. Build the Docker containers:

   docker compose build

3. Start the application:

   docker compose up

4. Access

   http://localhost:3000

Environment Variables

This project requires environment variables to be set up. Follow these steps to create and configure the .env file:

1. Copy the .default.env file in the src directory to create a new .env file in the same directory:

   cp src/.default.env src/.env
   

2. Open the .env file and set the Firebase authentication information and other necessary environment variables. For example:

   DATABASE_URL="postgresql://postgres:example_password@db:/app_db" 👈 no touch
   NEXT_PUBLIC_FIREBASE_API_KEY=""
   NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=""
   NEXT_PUBLIC_FIREBASE_DATABASE_URL=""
   NEXT_PUBLIC_FIREBASE_PROJECT_ID=""
   NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=""
   NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=""
   NEXT_PUBLIC_FIREBASE_APP_ID=""

   Replace the placeholder values with your actual Firebase project credentials.
   Note: You do not need to modify the DATABASE_URL value.