https://github.com/gonzaloplaza/cognito-workshop
Cognito Workshop repository (2022)
https://github.com/gonzaloplaza/cognito-workshop
aws aws-cognito docker express nodejs
Last synced: 8 months ago
JSON representation
Cognito Workshop repository (2022)
- Host: GitHub
- URL: https://github.com/gonzaloplaza/cognito-workshop
- Owner: gonzaloplaza
- License: mit
- Created: 2022-03-24T11:45:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-30T14:55:43.000Z (over 3 years ago)
- Last Synced: 2024-12-29T14:38:48.514Z (10 months ago)
- Topics: aws, aws-cognito, docker, express, nodejs
- Language: TypeScript
- Homepage:
- Size: 179 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cognito Workshop REST API
[](https://www.typescriptlang.org/)
[](LICENSE)
This is another Express + TypeScript + DDD (Domain Driven Design patterns) + IoC/DI (Inversion of
control and Dependency injection) + API REST boilerplate.
Author: Gonzalo Plaza
## Installation and Configuration
```bash
yarn install
```
### Generate .env file
```bash
cp .env.dist .env
```
You have to configure local environment variables with your own parameters inside _.env_ file.
These are the default values:
```env
PORT=3000
APP_NAME="cognito-workshop"
APP_LOG_LEVEL="debug"
AWS_ACCESS_KEY_ID="your_aws_access_key_id"
AWS_SECRET_ACCESS_KEY="your_aws_secret_access_key"
COGNITO_USER_POOL="your_cognito_user_pool"
COGNITO_CLIENT_ID="your_cognito_client_id"
COGNITO_REGION="your-aws-region-x"
```
### Development with nodemon (Runs on 3000 port)
```bash
yarn dev
```
### Run tests and generate coverage report
```bash
yarn test #In progress
```
### Build/Compile JS (to /dist folder)
```bash
yarn build
```
### Authentication with AWS Cognito
AWS Cognito is implemented as default authentication service. Please, check documentation on how to
configure it for more details: https://aws.amazon.com/cognito/getting-started/
---
### Docker Compose (for development)
This project is ready to work with **[docker-compose 3.8](https://docs.docker.com/compose/)** to
initialize the needed stack during development process. To start working run the following commands:
```bash
docker-compose build
docker-compose up
```
To shut down local stack:
```bash
docker-compose down
```
### Working docker compose environment (Port 8080)
```bash
curl http://localhost:8080/
```
Example JSON response (/):
```json
{
"success": true,
"message": "Hello Cognito Workshop",
"timestamp": 1648208765884
}
```
### Build Docker image for production
You can build an optimized Docker production-ready image with the standard command:
```sh
docker build --no-cache -t cognito-workshop .
```
And then run the container passing environment variables within the initialization:
```sh
docker run --rm -it -p 3000:3000 \
-e NODE_ENV=production \
-e AWS_ACCESS_KEY_ID="your_aws_access_key_id" \
-e AWS_SECRET_ACCESS_KEY="your_aws_secret_access_key" \
-e COGNITO_USER_POOL="your_cognito_user_pool" \
-e COGNITO_CLIENT_ID="your_cognito_client_id" \
-e COGNITO_REGION="your-aws-region-x" \
-e APP_LOG_LEVEL="info" \
--name cognito-workshop cognito-workshop
```
### Deploy Stack to AWS
In order to create/deploy the current stack to AWS using CloudFormation you'll need to generate your own _.aws-envs_
file that you can copy from the provided template:
```bash
cp .aws-envs.example .aws-envs
```
Note: This process will need a proper role created into your AWS Account with enough permissions to create all needed
resources, including IAM roles. You will need also to specify a working AWS VPC and 2 subnets. To execute it:
```bash
yarn deploy-stack # This is valid for stack create or update.
```
And to remove stack from cloudformation:
```bash
yarn remove-stack
```
### Todo
- [ ] Decouple dependency on aws key and secret variables
- [ ] Link AWS LoadBalancer to Route53 domain and SSL certificate
- [ ] Add tests and coverage
### Help and references
- https://nathanpeck.com/speeding-up-amazon-ecs-container-deployments
- https://docs.aws.amazon.com/es_es/AWSCloudFormation/latest/UserGuide/AWS_ECS.html
- https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html
- https://docs.aws.amazon.com/es_es/AWSCloudFormation/latest/UserGuide/AWS_ElasticLoadBalancingV2.html
- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-targetgroup.html
- https://github.com/aaronwht/aws-ecs-typescript