Online Store API

Getting Started

Follow these steps to get the project setup on your machine.

1. Clone the repository

git clone [email protected]:ToniPetrov03/online-store-api.git

2. Install Docker

Download and run the relevant installer for your operating system from here: https://docs.docker.com/get-docker/

3. docker-compose installation

# Build docker image
docker-compose build

# Run the app
docker-compose up

4. Setup complete

You can now access the application in your browser.

• API - http://localhost:4200/
• CLIENT - http://localhost:3000/
• Database UI - http://localhost:8080/

Guidelines

Build images

# Build api image
docker build ./api --file api/Dockerfile.prod --tag <user>/online-store_api:<version>

# Build client image
docker build ./client --build-arg REACT_APP_API_URL=http://localhost:4200 --build-arg DISABLE_ESLINT_PLUGIN=true --file client/Dockerfile.prod --tag <user>/online-store_client:<version>

Push images

# Push api image
docker push <user>/online-store_api:<version>

# Push client image
docker push <user>/online-store_client:<version>

Run images

# Create network
docker network create online-store

# Run the db
docker run --name mysql --rm --network online-store -p 3306:3306 -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=online_store_development -e MYSQL_USER=admin -e MYSQL_PASSWORD=123456 mysql:8.0.20

# Run the api
docker run --name=online-store-api --rm --network=online-store -p 4200:4200 -e PORT=4200 -e MYSQL_USER=admin -e MYSQL_PASSWORD=123456 -e MYSQL_DATABASE=online_store_development -e MYSQL_HOST_IP=mysql <user>/online-store_api:<version>

# Run the client
docker run --name=online-store-client --rm --network=online-store -p 1337:80 <user>/online-store_client:<version>

Live URLs

This section is empty

Running tests

This section is empty

Migrations

Pending migrations are run automatically on start. For more specific info see commands below.

# Connect to api docker container
docker ps
docker exec -it <containerId> sh

# Check migration status
npx sequelize-cli db:migrate:status

# Run all pending migrations
npx sequelize-cli db:migrate

# Undo latest migration
npx sequelize-cli db:migrate:undo

# Generate migration (make sure you change file extension to cjs)
npx sequelize-cli migration:generate --name <name-of-migration>

# Generate model + migration (make sure you change migration file extension to cjs)
npx sequelize-cli model:generate --name <ModelName> --attributes <attribute-name>:<attribute-type>,...