Skip to content

Commit 8f5de96

Browse files
committed
Mention documentation endpoint
1 parent ba69f36 commit 8f5de96

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,6 @@ Once started, the backend will expose a number of endpoints:
4242
- Legacy JQuery web application: [localhost:5000/old](http://localhost:5000/old);
4343
- API v2: [localhost:5000/v2](http://localhost:5000/v2);
4444
- New Vue web application: [localhost:5000/](http://localhost:5000/) (assuming a [vue-app](https://github.com/coderbotorg/vue-app) build is placed in the `dist/` folder);
45+
- Documentation: [localhost:5000/docs](http://localhost:5000/docs) assuming a [docs](https://github.com/coderbotorg/docs) build is placed in the `cb_docs/` folder);
4546
- Swagger UI dynamic documentation of the API v2: [localhost:5000/v2/ui/index.html](http://localhost:5000/v2/ui/index.html) (once you cloned the [swagger-ui](https://github.com/coderbotorg/swagger-ui) repository inside the backend folder).
4647

0 commit comments

Comments
 (0)