Skip to content

Update README to include information about external services #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kTrzcinskii merged 1 commit into from
Mar 10, 2025
Merged

Update README to include information about external services #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,15 @@ Resellio API is the backend service for the Resellio application, providing an i
- dotnet version >= `9.0`
- docker version >= `28.0`

### External Services

This project uses the following external services:

- **PostgreSQL** – as the main relational database.
- **Redis** – for caching and other fast in-memory operations.

Both services are managed using **Docker Compose**, and are defined in the `docker-compose.yml` file. When running locally, Docker will automatically provision and run these services.

### Running locally

1. Clone the repository:
Expand All @@ -23,13 +32,12 @@ Resellio API is the backend service for the Resellio application, providing an i
```bash
docker compose up
```

3. Set up environment variables:

Create an `appsettings.json` file in the root of the project, following the structure
of `appsettings.example.json` found in `TickAPI/TickAPI/appsettings.example.json`.


4. Run application:

```bash
Expand Down