gacha-world

Catching gacha for fun

Usage

Set up Environment

Rename .env.example to .env and change the values as needed.

Create HTTPS certificates & JWT Secrets

Create self-signed certificates + private and public key for JWT:

./init.sh

Build the application

docker compose up -d --build

Access the endpoints

• Main Features: Navigate to https://localhost:5000/docs to explore and interact with the API documentation for the application's main features.
• Admin Features: Access the admin-specific functionalities at https://localhost:5001/docs.

Testing

Unit Tests

Prepare the environment:

npm install -g newman

Auth service:

cd docs/tests
./auth_unit_test.sh
cd -

Player service:

cd docs/tests
./player_unit_test.sh
cd -

Auction service:

cd docs/tests
./auction_unit_test.sh
cd -

Integration Testing (ATTENTION: This will remove all data in the volumes)

Auth service:

cd docs/tests
./auth_integration_test.sh
cd -

Player service:

cd docs/tests
./player_integration_test.sh
cd -

Auction service:

cd docs/tests
./auction_integration_test.sh
cd -

Security Testing

Run bandit and pip-audit using docker-compose:

docker compose run --rm bandit
docker compose run --rm pip-audit