Skip to content
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

Docs/update readme #240

Merged
merged 1 commit into from
Oct 22, 2023
Merged

Docs/update readme #240

Show file tree
Hide file tree
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
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,9 @@ AltCamp by AltSchool is an e-learning platform that allows students to post mess
## Quick Links

### API
- Base URL: https://the-altcamp.onrender.com
- Documentation: https://the-altcamp.onrender.com/api-docs or `<base_url>/api-docs`
- Base URL (dev): https://altcamp.onrender.com
- Base URL (prod): https://api.thealtcamp.com
- Documentation: https://altcamp.onrender.com/api-docs or `<base_url>/api-docs`
- Postman Collection: https://documenter.getpostman.com/view/21313847/2s93eePUTg#intro

### Frontend
Expand Down
5 changes: 3 additions & 2 deletions src/docs/endpoints.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,11 @@ servers:
- http
- https
host:
default: the-altcamp.onrender.com
default: altcamp.onrender.com
enum:
- localhost:8000 # Local development server
- the-altcamp.onrender.com # Development server
- altcamp.onrender.com # Development server
- api.thealtcamp.com # Production server

paths:
# --------------- AUTHENTICATION ---------------
Expand Down