https://github.com/almirjnr/tech-test-payment-api

api-rest asp-net-core authentication-flow docker dotnet postgresql swagger technical-test xunit

Last synced: 7 months ago
JSON representation

Pottencial Seguradora .NET Technical test

Host: GitHub
URL: https://github.com/almirjnr/tech-test-payment-api
Owner: AlmirJNR
License: mit
Created: 2022-09-27T22:03:22.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2022-10-14T18:30:47.000Z (almost 3 years ago)
Last Synced: 2025-01-20T05:37:38.317Z (9 months ago)
Topics: api-rest, asp-net-core, authentication-flow, docker, dotnet, postgresql, swagger, technical-test, xunit
Language: C#
Homepage:
Size: 207 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

README

## POTTENCIAL SEGURADORA TECHNICAL TEST
OBS: The test instructions are located [HERE](./TESTINSTRUCTIONS.md)

## PROJECT TECHNOLOGIES:
- ASP.NET Core 6
- XUnit
- OpenApi/Swagger
- PostgreSQL 14
- Docker
- Docker Compose

## BUILD & RUN
To run this api you are going to first build the database,
then either run it in development or production mode.

- Database:
- **You Need** to have docker installed
- RUN `docker compose up database --build`

DISCLAIMER: you can skip the database part
if you pretend to run the api in production mode

- Developer mode:
- Open your favourite IDE and run it
- OR
- RUN `dotnet restore && dotnet run`

- Production mode (with docker compose):
- **You Need** to have docker installed
- RUN `docker compose up --build`

Ports that are going to be exposed by the container by default are:
- 5432 -> PostgreSQL
- 5182 -> Protocol: Http, Api: ECommerce

## DOCUMENTATION
Swagger is available at the root of `http://localhost:5182`, but
only when the project is executed in `Development mode`