- Clone the repository
git clone <git lab template url> <project_name>
- Install dependencies
cd animate-everything
npm install
- Setup env variables
1) Create .env directory in root folder for docker
2) Create .env file in ~/server/src/ folder
By the way i have been created .env.example files so you can use them or create your own .env files, as you wish)
- Build and run the project
1) npm i
2) npm run start:(server|client|transcoder)
3) You can run rabbitmq and database locally, but envs should match
or you can just run them in docker (npm run docker:up:debug:backend)
-
API Document endpoints
swagger Spec Endpoint : http://localhost:5001/api-docs
In this project i used cloudinary as media cloud : https://cloudinary.com/.
But you can modify cloud adapter and corresponding interface to replace it with firebase storage or s3 bucket.
- npm run docker:build - To build images
- npm run docker:up or npm run docker:up:d to run project in detached mode
Add Typescript to project npm.
npm install -D typescript
The folder structure of this app is explained below:
| Name | Description |
|---|---|
| dir | Contains something |
work on it later...
| Npm Script | Description |
|---|---|
build:shared |
Build shared module |
start:server |
Runs server locally |
start:client |
Runs client locally |
docker:up |
Runs project in dockers |
docker:up:d |
Same that 'docker:up' but in detached mode |
docker:down |
Remove all containers |
All rules are configured through .eslintrc.yml.
To find problems in your code
npm run lint