- Please have Docker installed on your operating system.
yarn install
.docker-compose up --build
to run the development server.
docker-compose up --build
- builds the docker environment & loads up a development server.docker-compose up
- uses your existing images and spins up the dev server.docker-compose down
- closes the docker development environment & removes the build.yarn build
- builds the server from typescript for production.yarn start
- runs the production build.yarn lint
- lints the code and shows you what type of ESLint errors there are.yarn lintfix
- ESLint fixes the lint errors.
If you're using a GUI (like HeidiSQL on Windows/Sequel Ace on MacOS) to access the Docker MariaDB Database. Below are the credentials you'll need to see the data that's being entered in the development database.
- Spin up the dev environment with
docker-compose up
Host: `0.0.0.0`
User: `root`
Password: `password`
Database: `retail_ai`
Port: `8081`
If you're installing new dependencies, you'll need to rebuild the docker images. Run docker-compose up --build
to build a fresh build.
.env
file needs to be created that will take the following parameters.
SERVER_HOST - Host URL to access the server.
SERVER_PORT - Host PORT to access the server.
DB_HOST - web/local address where the MariaDB database is located.
DB_USER - username on the MariaDB server.
DB_PASSWORD - Password to access MariaDB.
DB_NAME - `retail_ai`.
ORIGINS - CORS Related Websites.