Nest framework TypeScript starter repository.
1. Clone the repository:
git clone https://github.com/cristianManco/test-Back-end- Install the dependencies:
cd your-repository
npm install$ yarn install
## Running the app
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
# unit tests
$ yarn run test
# e2e tests
$ yarn run test:e2e
# test coverage
$ yarn run test:covTorneos Van Rossum is a platform dedicated to managing esports tournaments in Colombia. This repository contains the API for managing tournaments, players, and match results.
- Register, update, and query players
- Create, update, delete, and query tournaments
- Add participants to a tournament and query the tournament with its participants
- Randomly assign competition in a tournament among registered players
- Register the results of the competition with winner and loser data and the score obtained by each competitor
- Query player results per tournament with at least one score filter (>=), sorting by scores, and pagination
- Node.js
- NestJS
- TypeORM
- PostgreSQL or MySQL
src/
|-- global/
| |--config.ts # Configuration file for database and other settings
| |--Guard/ # guard configuration for sales
|
|-- player/
| |-- entities/ # Author entity definition
| |-- dto/ # DTOs (Data Transfer Objects) for author operations
| |-- controller/ # Controller for author operations
| |-- module/ # Module for author-related functionalities
| |-- service # Service for author operations
|
|-- result/
| |-- dto/ # DTOs for book operations
| |-- entities/ # Book entity definition
| |-- controller/ # Controller for book operations
| |-- module/ # Module for book-related functionalities
| |-- service # Service for book operations
|
|-- tournament/
| |-- dto/ # DTOs for sales operations
| |-- entities/ # Sale entity definition
| |-- controller/ # Controller for sales operations
| |-- module/ # Module for sale-related functionalities
| |-- service # Service for sale operations
|
|-- app.module.ts # Main application module
|-- main.ts # Application entry point
|-- ... # Other files and folders
To contribute to this project, follow these steps:
- Fork this repository.
- Create a new branch with the prefix
feature/orfeat/followed by your feature name. - Make your changes and tests.
- Make a pull request to the
developbranch of this repository.
This project is licensed under the MIT License. See the LICENSE file for more details.
For any questions or issues, Cristian Manco at camilomanco2005@gmail.com Thank you for using our API!
- Set up your database and add the connection details to a
.envfile in the root of your project:
DATABASE_TYPE=postgres
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_USERNAME=yourusername
DATABASE_PASSWORD=yourpassword
DATABASE_DB=yourdatabase- Run the migrations:
npm run migration:run- Start the application:
npm run startThe application will be running at http://localhost:3000.
The API is documented using Swagger and is available at http://localhost:3000/api.
We use Gitflow for branch management and versioning. Please ensure that your commits are descriptive and that your branches follow the Gitflow convention.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.
- Author - Cristian Manco
Nest is MIT licensed.