**b)** Now, on your computer, navigate to the directory in which you want to download the project (ie. perhaps one called `development/SRCT`), and run
git clone git@git.gmu.edu:srct/go.git
## 3) Get Go up and running with the method of your choice.
Now that we have `git` setup and cloned down the code you can
cd go/
and get to working on setting up a development environment!
### Docker
Docker is an emerging containerization platform written in Google's Go
language.
Instead of running a full VM that runs Go, we package up all the
various bits that make up Go and run that as a container (two
containers: one for Go and the other for mysql) that act as normal
processes to the OS.
Check out [docker.com](https://www.docker.com/what-docker) for more details.
Pros:
- Lightweight
- Can be run on most machines without needing significant resources.
- SRCT members report minimal battery impact on laptops.
- Fast
- Compared to other methods, Docker is comparatively faster than
Vagrant or manual setup.
- Minimal setup
- You run one command. Really easy to get up and running once you install
Docker.
- Good cross platform support
- Runs smoothly on macOS, Linux, and Windows
- Great docs to help if you get stuck.
- Can easily destroy and rebuild the docker images
- Loads in changes to code on the fly
Cons:
- Challenging to debug problems
- Cannot interact with attached images and as a result, you cannot really
interact with the database.
There are instructions on how to setup/develop with Docker at the [docker-configuration page in the Go project wiki](https://git.gmu.edu/srct/go/wikis/docker-configuration).
**NOTE**: On Windows, Docker only works if you have Windows 10 Eductaion or Pro,
as it requires HyperV.
### Manual Setup
Manual setup (or: the old fashioned way) is where you install all dependecies on
your system and run Go as a local server with Django. Granted you are technically
doing that with Docker except those platforms automate the steps that
are laid out in this section.
Pros:
- Experience setting up a Django project for local development
Cons:
- Way more steps
Head to:
https://git.gmu.edu/srct/go/wikis/manual-setup
# Some words about contributing to Go.
# Some words about contributing to Go.
...
@@ -165,18 +35,6 @@ the repo and on Google.
...
@@ -165,18 +35,6 @@ the repo and on Google.
Unit tests are run on every commit sent to gitlab though that can be a pain to
Unit tests are run on every commit sent to gitlab though that can be a pain to
rely on. Here's how to run them locally:
rely on. Here's how to run them locally:
#### Docker
Docker is not supported currently for running unit tests. If you're able to get
it set up, open a merge request and I'll merge it in.
#### Manual Setup
Assuming you are within your virtualenv:
python manage.py test
## CONTRIBUTING.md
## CONTRIBUTING.md
This document goes into detail about how to contribute to the repo, plus some
This document goes into detail about how to contribute to the repo, plus some
...
@@ -198,17 +56,6 @@ I will not accept commits that contain uncommented code.
...
@@ -198,17 +56,6 @@ I will not accept commits that contain uncommented code.
I encourage you to join the [#go channel](https://srct.slack.com/messages/go/details/) in SRCT's [Slack Group](https://srct.slack.com)
I encourage you to join the [#go channel](https://srct.slack.com/messages/go/details/) in SRCT's [Slack Group](https://srct.slack.com)
if you have any questions on setup or would like to contribute.
if you have any questions on setup or would like to contribute.
