Welcome to Backend Challenge 👋

Prerequisites

• npm >=8.1.0
• node >=18.13.0
• docker

Start your environment

1. Init your .env file

You should use the .env.example to create a new file with name .env

2. Install dependencies

npm ci

3. Docker Compose

You should use docker-compose to start your environment with all services used

docker compose up -d

And access to http://localhost:4567

Usage

You can preview in real time your changes, you need run

# development
$ npm run build -- <APP_NAME>
$ npx serverless offline

And access to http://localhost:3000

Test

# unit tests
$ npm run test

# test coverage
$ npm run test:coverage

Migrations

# create entity
# you will have to rename the class manually following the project standards
$ npm run typeorm:create-entity apps/src/infrastructure/domain/user.entity

# create migration
# normally the file name follows the name of the action to perform: createTable, updateTable, addColumn, dropColumn
$ npm run typeorm:generate-migration database/migrations/CreateUserTable

# Run migrations
$ npm run typeorm:run-migration

Seeds

# Run database/seeds/user.seed.ts
$ npm run run-seed UserSeed

Docker Compose

Currently we using docker-compose with the next services:

Postgres & Adminer

We use a AWS RDS to this case, we using postgresql and adminer to managmente database.

You can access to adminer here

Minio as S3

We use Minio as AWS S3 Bucket, you can access to Minio console and created a new private bucket here, the default credentials are:

User: default_access_key Password: default_secret_key

Author

👤 Umvel Inc

• Website: https://umvel.com/

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is CC--BY--4.0 licensed.

---

This README was generated with ❤️ by readme-md-generator