Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SRCT
whats-open
Commits
3c9bb8f9
Commit
3c9bb8f9
authored
Sep 20, 2019
by
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
Changes
2
Pipelines
1
Show whitespace changes
Inline
Side-by-side
README.md
View file @
3c9bb8f9
...
...
@@ -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
walk-through of steps we will take:
1.
Install
`git`
on your system.
2.
Clone the whats-open codebase.
3.
Get whats-open up and running with the method of your choice.
## 1) Install `git` on your system.
<details><summary>
</h2>
1) Install
<code>
git
</code>
on your system.
</h2>
</summary>
<p>
`git`
is the version control system used for SRCT projects.
...
...
@@ -83,8 +82,14 @@ Next, to make sure Homebrew is up to date, run:
Finally we can install git with:
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
)
,
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
## 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
...
...
@@ -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
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
)
containers! This allows us to quickly get started and standardize development
...
...
@@ -134,8 +148,22 @@ user: admin@masonlive.gmu.edu
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.
First, install python, pip, and virtualenv on your system.
...
...
@@ -287,6 +315,20 @@ to your database.
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
With the means of testing the website, you can really start contributing.
...
...
docker-compose.yml
View file @
3c9bb8f9
...
...
@@ -14,6 +14,7 @@ services:
MYSQL_PASSWORD
:
wopen
api
:
container_name
:
whats_open_api
build
:
.
ports
:
-
"
8000:8000"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment