[TODO: Add a brief 1-2 sentence description of what this project does here.]
This guide provides instructions on how to set up, run, and manage the Nizek Task application using Docker.
Before you begin, ensure you have the following installed on your system:
- Git: For cloning the repository.
- Docker: For containerization. (Install Docker)
- Docker Compose: For managing multi-container Docker applications. (Usually included with Docker Desktop, otherwise Install Docker Compose)
Follow these steps to get the application running locally.
-
Clone the Repository:
git clone https://github.com/starfall1991/nizek-task.git cd nizek-task
-
Configure Environment Variables: Copy the example environment file. You must review and potentially edit the
.env
file to set necessary configuration variables (like database credentials, API keys, ports, etc.) specific to your environment.cp .env.example .env
Edit
.env
with your preferred text editor. -
Prepare Database File: This setup requires the SQLite database file to exist before starting the containers. Create the empty file:
touch database/database.sqlite
-
Build and Start Containers: This command will build the Docker images (if they don't exist or if changes were made) and start the services defined in
docker-compose.yml
in detached mode (running in the background).docker-compose up -d --build
-
Wait for Services: Allow some time for the containers to start and become healthy. The application might need a moment to initialize fully after the container starts. You can check the status using:
docker-compose ps
Or view the logs (press
Ctrl+C
to stop viewing):docker-compose logs -f
Once the containers are running and healthy, you should be able to access the application via your web browser at:
http://localhost:9000
To stop the running containers:
docker-compose down