Skip to content

Commit

Permalink
Merge pull request #240 from AltCamp/docs/update-readme
Browse files Browse the repository at this point in the history
Docs/update readme
  • Loading branch information
tobisupreme authored Oct 22, 2023
2 parents b416392 + 8955b36 commit c4ee7db
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
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
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

0 comments on commit c4ee7db

Please sign in to comment.