Commit 3c9bb8f9 authored by Michael Lundquist's avatar Michael Lundquist
Browse files

Adding fixture docs to the README.md and making some sections collapsible

parent 3d410741
Pipeline #4775 passed with stage
in 1 minute and 9 seconds
...@@ -34,11 +34,10 @@ Check out some of the other What's Open projects! ...@@ -34,11 +34,10 @@ Check out some of the other What's Open projects!
What's Open currently supports developers on Linux and macOS systems. Here's our What's Open currently supports developers on Linux and macOS systems. Here's our
walk-through of steps we will take: walk-through of steps we will take:
1. Install `git` on your system. <details><summary>
2. Clone the whats-open codebase. </h2> 1) Install <code>git</code> on your system.</h2>
3. Get whats-open up and running with the method of your choice. </summary>
<p>
## 1) Install `git` on your system.
`git` is the version control system used for SRCT projects. `git` is the version control system used for SRCT projects.
...@@ -83,8 +82,14 @@ Next, to make sure Homebrew is up to date, run: ...@@ -83,8 +82,14 @@ Next, to make sure Homebrew is up to date, run:
Finally we can install git with: Finally we can install git with:
brew install git brew install git
</p>
</details>
<details><summary>
</h2> 2) Clone the whats-open codebase </h2>
</summary>
<p>
## 2) Clone the whats-open codebase
Now, we're going to clone down a copy of the whats-open codebase from [git.gmu.edu](http://git.gmu.edu/srct/whats-open), Now, we're going to clone down a copy of the whats-open codebase from [git.gmu.edu](http://git.gmu.edu/srct/whats-open),
the SRCT code respository with SSH. the SRCT code respository with SSH.
...@@ -97,7 +102,13 @@ the SRCT code respository with SSH. ...@@ -97,7 +102,13 @@ the SRCT code respository with SSH.
git clone git@git.gmu.edu:srct/whats-open.git git clone git@git.gmu.edu:srct/whats-open.git
## 3) Get whats-open up and running </p>
</details>
<details><summary>
</h2> 3) Get whats-open up and running </h2>
</summary>
<p>
Now that we have `git` setup and cloned down the code you can Now that we have `git` setup and cloned down the code you can
...@@ -106,7 +117,10 @@ Now that we have `git` setup and cloned down the code you can ...@@ -106,7 +117,10 @@ Now that we have `git` setup and cloned down the code you can
and get to working on setting up a development environment! There are two options and get to working on setting up a development environment! There are two options
to go about doing this: `Docker` and `Manual Setup`. to go about doing this: `Docker` and `Manual Setup`.
### Docker <details><summary>
</h3> Docker</h3>
</summary>
<p>
We can automate the setup process through [Docker](https://www.docker.com/what-docker) We can automate the setup process through [Docker](https://www.docker.com/what-docker)
containers! This allows us to quickly get started and standardize development containers! This allows us to quickly get started and standardize development
...@@ -134,8 +148,22 @@ user: admin@masonlive.gmu.edu ...@@ -134,8 +148,22 @@ user: admin@masonlive.gmu.edu
pass: admin pass: admin
``` ```
### Manual Setup ### Loading Default Data
Django apps use fixtures to load default data for testing. To load the api's fixtures use the following command in the terminal:
```
docker exec whats_open_api python3 /whats-open/whats-open/manage.py loaddata --format json categoriesFixture locationFixture openTimeFixture scheduleFixture settingsFixture
```
</p>
</details>
<details><summary>
</h2> Manual Setup </h2>
</summary>
<p>
Manual Setup involves all of the same steps as Docker, but just done manually. Manual Setup involves all of the same steps as Docker, but just done manually.
First, install python, pip, and virtualenv on your system. First, install python, pip, and virtualenv on your system.
...@@ -287,6 +315,20 @@ to your database. ...@@ -287,6 +315,20 @@ to your database.
With that, everything should be good to go! With that, everything should be good to go!
### Loading Default Data
Django apps use fixtures to load default data for testing. To load the api's fixtures use the following command:
```
python3 manage.py loaddata --format json categoriesFixture locationFixture openTimeFixture scheduleFixture settingsFixture
```
</p>
</details>
</p>
</details>
# Modifying and Deploying Code # Modifying and Deploying Code
With the means of testing the website, you can really start contributing. With the means of testing the website, you can really start contributing.
......
...@@ -14,6 +14,7 @@ services: ...@@ -14,6 +14,7 @@ services:
MYSQL_PASSWORD: wopen MYSQL_PASSWORD: wopen
api: api:
container_name: whats_open_api
build: . build: .
ports: ports:
- "8000:8000" - "8000:8000"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment