Before you begin, ensure you have met the following requirements:
- Node.js and npm installed on your machine. You can download them from here.
- Docker and Docker Compose installed on your machine. You can download Docker from here.
Verify the installations by running:
node -v
npm -v
docker --version
docker-compose --version
Clone this repository to your local machine using Git:
git clone https://github.com/your-username/your-repository.git
cd your-repository
cd frontend
npm install
cd ..
cd backend
npm install
This project uses Docker Compose for containerization. Follow the steps below to run it:
Use Docker Compose to build the Docker images and start the containers:
docker compose up -d
The -d flag runs the containers in detached mode.
To check the status of your containers, use:
docker compose ps
To update typescript types, use:
cd frontend
npx graphql-codegen --watch
Once the project is running, access it by navigating to http://localhost:8080 in your web browser for the frontend. To see Appollo Studio in the backend, access it by navigating to http://localhost:8080/api.
- Rebuild To rebuild if if you added dependencies, modified the dockerfile or compose.yml:
docker compose up --build -d
- View Logs
To view the logs of your Docker containers:
docker compose logs -f
- Stop the Containers
To stop the running containers:
docker compose stop
- Remove the Containers
docker compose down
- Connect on server
ssh wns_student@092024-rouge-5.wns.wilders.dev -p 2269
- View Logs
To view the logs of your Docker containers:
# webhook
journalctl -u webhook -f
# Nginx
tail -f apps/production/logs/access.log
# or
tail -f apps/production/logs/error.log