/builder-bootcamp-nodejs-starter-kit

Primary LanguageTypeScript

builder-bootcamp-nodejs-starter-kit

Requirements

Initial setup & deployment

Prepare the infrastructure

  1. Create an S3 bucket
aws s3 mb s3://bootcamp-starter-kit-$USER

Note: For Windows environments, you may use the following powershell command

aws s3 mb s3://bootcamp-starter-kit-$env:UserName
  1. Deploy the infrastructure
make infra

Note: For Windows envirnonments, you may use the following powershell command

cd .\infrastructure\ && ./deploy.ps1

Deploy the application

  1. Add a new git remote and point it at the CodeCommit repo created by make infra
git remote add codecommit <codecommit-clone-url-http>
  1. Push your changes and the pipeline should kick off a build
git push -u codecommit main

Local development

Please refer to the troubleshooting section for help with setting up authentication and authorization

Run unit tests

  1. Run the unit tests
make test
  1. Hope they work!

Start the local dev server

  1. Install npm dependencies
npm install
  1. Start up the dev server
make dev

  1. Write code, it will be automatically recompiled on save.

  2. Test your work at the address returned

Running the Swagger editor

  1. Start the service
make swagger-start

  1. Point your browser to http://0.0.0.0:8080

  2. When done, stop the service

make swagger-stop

Troubleshooting

If you face the The requested URL returned error: 403 error while performing git operations:

  1. Check if your AWS account user being used has the following 3 permissions:

    1. AWSCodeCommitFullAccess
    2. AWSCodeCommitPowerUser
    3. AWSCodeCommitReadOnly

  2. Make sure git credentials are setup properly as described here