todo: add some project description
-
Pay attention, that we have certain quality criteria, which we should follow during application development.
-
Staging.
-
Production.
-
Obviously, you have to install Docker.
-
Run Docker Desktop application. You shouldn't get any errors.
-
Create
.env
folder in the root of repository. Copy all files from.env.example
folder to.env
-
Open .docker folder in command line and run next command
docker-compose up --build
. -
You should be able to access backend API specification and frontend app
-
If something went wrong, use this link to fix your problem
tips:
-
If you want to run application services (like database) and don't want to waste time installing them, run this command in .docker folder
docker-compose -f docker-compose.services.yml up --build
. -
If you want to test production environment localy, do next steps:
1 Change
ASPNETCORE_ENVIRONMENT=Development
line toASPNETCORE_ENVIRONMENT=Production
in .env\ats_api.env file2 Go to
backend\src\WebAPI\Extensions\CorsExtenstion.cs
file, find methodAddProductionCorsPolicies
and follow described instructions.
-
Go to
backend/src/WebAPI/Properties
. -
Create file
launchSettings.json
. -
Copy content of
example.launchSettings.json
tolaunchSettings.json
.
- Create AWS account https://portal.aws.amazon.com/billing/signup#/start
- Sign in to the AWS console as an IAM user with admin rights (for example Root user) https://signin.aws.amazon.com/signin
- Create new user with Programmatic access using tutorial - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html
- note: best practice is to follow The Principle of Least Privileges. I recommend use AmazonS3FullAccess policy for your user.