tanner/spaceport
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Tanner Collin 2022-04-07 19:58:20 +00:00
parent 3b449ffa02
commit eb7d34c92d
4 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apiserver/docs/source/api.md
View File

@ -1,6 +1,6 @@
# Spaceport API # Spaceport API
The current API URL is: https://api.my.protospace.ca/ The current API URL is: [https://api.my.protospace.ca/](https://api.my.protospace.ca/).
JSON is returned by all API responses including errors and HTTP response status JSON is returned by all API responses including errors and HTTP response status
codes are to designate success and failure. codes are to designate success and failure.

2
apiserver/docs/source/dev_apiserver.md
View File

@ -1,6 +1,6 @@
# API Server Development Setup # API Server Development Setup
This guide assumes you are using Debian GNU/Linux 11 or Ubuntu 20.04 LTS. If you This guide assumes you are using [Debian GNU/Linux 11](https://cdimage.debian.org/cdimage/unofficial/non-free/images-including-firmware/archive/11.2.0+nonfree/amd64/iso-cd/firmware-11.2.0-amd64-netinst.iso) or [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). If you
aren't, just spin up a VM with the correct version. Things break if you don't. aren't, just spin up a VM with the correct version. Things break if you don't.
## Install Dependencies ## Install Dependencies

3
apiserver/docs/source/dev_running.md
View File

@ -12,7 +12,8 @@ IP if your virtual machine or server is.
Open the web client [http://127.0.0.1:3000/](http://127.0.0.1:3000/) in your browser. Open the web client [http://127.0.0.1:3000/](http://127.0.0.1:3000/) in your browser.
Fill out the "Sign Up to Spaceport" form. If you see a "Please Visit Protospace" Fill out the "Sign Up to Spaceport" form. If you see a "Please Visit Protospace"
warning, this means the web client can't talk to the API server properly. warning, this means the web client can't talk to the API server properly. Hit
Sign Up and finish the registration.
Navigate to [http://127.0.0.1:8000/admin/api/member/1/change/](http://127.0.0.1:8000/admin/api/member/1/change/) and log in with the Navigate to [http://127.0.0.1:8000/admin/api/member/1/change/](http://127.0.0.1:8000/admin/api/member/1/change/) and log in with the
super user credentials you created during the API server setup. super user credentials you created during the API server setup.

2
apiserver/docs/source/dev_webclient.md
View File

@ -1,6 +1,6 @@
# Web Client Development Setup # Web Client Development Setup
This guide assumes you are using Debian GNU/Linux 11 or Ubuntu 20.04 LTS. If you This guide assumes you are using [Debian GNU/Linux 11](https://cdimage.debian.org/cdimage/unofficial/non-free/images-including-firmware/archive/11.2.0+nonfree/amd64/iso-cd/firmware-11.2.0-amd64-netinst.iso) or [Ubuntu 20.04 LTS](https://releases.ubuntu.com/20.04/). If you
aren't, just spin up a VM with the correct version. Things break if you don't. aren't, just spin up a VM with the correct version. Things break if you don't.
## Install Dependencies ## Install Dependencies