Skip to content
Snippets Groups Projects
README.md 1.08 KiB
Newer Older
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
## CMPT 370 T2
Welcome to the CMPT 370 T2 project! This guide will help you get started with setting up the project environment using Docker.
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
## Prerequisites
Before you begin, please ensure you have Docker desktop installed on your machine. If you don't have Docker yet, you can download it from Docker Desktop.
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
    https://www.docker.com/products/docker-desktop/
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed


## Getting started

1) Clone the repository
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
    First, clone the Git repository to your local machine using the following command:
        git clone https://git.cs.usask.ca/asd028/cmpt-370-t2.git
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
2) Navigate to the Project Directory
    Change to the project directory in your terminal:
        cd ./cmpt-370-t2
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
3) Start Docker
    Use Docker Compose to build and start the project:
        docker-compose up --build 
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
4) Access the Application
    Once Docker has finished setting up, you can access the application by navigating to:
        http://localhost:3000
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
## Closing the Application
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
When you're done, you can shut down the Docker environment. To do this, use the following command:
Anmol Dhunna (asd028)'s avatar
Anmol Dhunna (asd028) committed
    docker-compose down -v