The purpose of the tool we are developing is explained in Objectives.
Currently, a live demo is running here: http://ergo-one-dev-webclientbucket-ionyhjid8p2l.s3-website.eu-central-1.amazonaws.com
- Python and Pip
- NodeJS and Yarn
- an account on AWS
- credentials for AWS named "ergo-one-developer" in your $HOME/.aws/credentials file.
Now you should run:
yarn install-python-requirementsto install the python packages needed to run the AWS CLIyarn installto install nodejs dependencies for the backendcd web-client && yarn installto install nodejs dependencies for the frontend
This project uses Prettier to enforce a uniform coding style. Every developer should set up their set up their IDE/editor of choice to automatically format code using Prettier whenever a file is saved.
On WebStorm, the following scope is used:
(file:*.ts||file:*.js||file:*.json||file:*.css||file:*.scss||file:*.vue||file:*.html||file:*.md||file:*.yml||file:*.yaml)&&!(file:*/coverage//*||file:*/dist//*)
More instructions can be found on the following page: https://prettier.io/docs/en/editors.html.
yarn create-sam-bucketIn order to deploy your own backend stack on AWS, use the following command:
yarn build-and-deploy:backend:devThe outputs displayed at the end of the deployment indicate the URLs of both:
- the API Gateway that serves the backend API
- the S3 Bucket that serves the web client (read on for instructions to populate the bucket)
In order to deploy the frontend to the S3 Bucket created in the step above, use the following command:
yarn build-and-deploy:frontend:devYou can now access the frontend from http://localhost:8080.
In order to run the backend locally, use the following command:
yarn build-and-deploy:backend:localYou can now access the backend on http://localhost:3000.
Note: Only the API Gateway and the Lambdas are deployed locally. The rest of the infrastructure, including DynamoDB, must still be deployed on AWS for the application to work.
In order to run the frontend locally, use the following command:
yarn build-and-deploy:frontend:localYou can now access the frontend from http://localhost:8080.