Skip to content

Commit

Permalink
docs: add openapi link
Browse files Browse the repository at this point in the history
  • Loading branch information
SverreNystad committed Jul 18, 2024
1 parent 4573ae0 commit 7f71c63
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- [1. Clone the repository](#1-clone-the-repository)
- [2. Navigate to the Project Directory:](#2-navigate-to-the-project-directory)
- [Usage](#usage)
- [Documentation 📚](#documentation-)
- [Documentation 📖](#documentation-)
- [Contributors](#contributors)
- [License](#license)

Expand Down Expand Up @@ -90,14 +90,13 @@ docker compose up --build
```

After starting the application, the frontend should be available at [http://localhost:3000/](http://localhost:3000/) and should pop up in your default browser.
The backend should be available at [http://localhost:8080/](http://localhost:8080/).
The backend should be available at [http://localhost:8080/](http://localhost:8080/). The backend has OpenAPI documentation available at [http://localhost:8080/swagger-ui.html](http://localhost:8080/swagger-ui.html) generated straight from the source code.

For the full development setup, see the [Developer Setup](docs/manuals/developer_setup.md) guide.

## Documentation 📚
## Documentation 📖
- [Developer Setup](docs/manuals/developer_setup.md) 🛠️
- [Testing](docs/manuals/testing.md) 🧪
- [API Documentation](docs/manuals/api_documentation.md) 📖
- [Docker Guide](docs/docker.md) 🐳
- [Understanding the Minimax Algorithm](docs/minimax.md) 🧠
- [Architecture](docs/architecture.md) 🏗️
Expand Down

0 comments on commit 7f71c63

Please sign in to comment.