Commit 62e4e340 authored by Zac Wood's avatar Zac Wood

Update README.md

parent 619c1b59
Pipeline #5354 passed with stages
in 2 minutes
...@@ -14,140 +14,10 @@ Go is currently a `Python 3` project written in the `Django` web framework, with ...@@ -14,140 +14,10 @@ Go is currently a `Python 3` project written in the `Django` web framework, with
# Setup instructions for local development # Setup instructions for local development
Go currently supports developers on Linux, macOS and Windows platforms through Go currently supports developers on Linux, macOS and Windows platforms. Please follow the setup instructions for your operating system:
both the Docker and Vagrant virtualization platforms. You may use either one - [Windows](https://git.gmu.edu/srct/go/-/wikis/Initial-Setup/Windows)
though we have included instructions for manual setup as well. Here's our walk-through - [Mac](https://git.gmu.edu/srct/go/-/wikis/Initial-Setup/Mac)
of steps we will take: - Linux (TODO. For now follow the Mac instructions with your disto's package manager instead of Homebrew)
1. Install `git` on your system.
2. Clone the Go codebase.
3. Get Go up and running with the method of your choice.
## 1) Install `git` on your system.
`git` is the version control system used for SRCT projects.
### On Linux Based Systems
**with apt:**
Open a terminal and run the following command:
sudo apt update
This retrieves links to the most up-to-date and secure versions of your packages.
Next, with:
sudo apt install git
you install `git` onto your system.
### On macOS
We recommend that you use the third party Homebrew package manager for macOS,
which allows you to install packages from your terminal just as easily as you
could on a Linux based system. You could use another package manager (or not
use one at all), but Homebrew is highly reccomended.
To get homebrew, run the following command in a terminal:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)
**Note**: You do NOT need to use `sudo` when running any Homebrew commands, and
it likely won't work if you do.
Next, to make sure Homebrew is up to date, run:
brew update
Finally we can install git with:
brew install git
### Windows
Download Git for Windows here:
[https://git-scm.com/download/win](https://git-scm.com/download/win)
## 2) Clone the Go codebase.
Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](https://git.gmu.edu/srct/go),
the SRCT code respository with SSH.
**a)** Configure your ssh keys by following the directions at:
[git.gmu.edu/help/ssh/README](https://git.gmu.edu/help/ssh/README).
**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.
# Some words about deploying Go.
Check out our admin guide:
https://git.gmu.edu/srct/go/wikis/administration-guide
In order to expire links, you need to set up a cron job to run the manage.py
expirelinks command regularly. A sample cron script is available in the
repository and is named go-cleanlinks.cron. Drop this in cron.hourly and
change the paths so that they point to the virtualenv activate script and
manage.py.
--- ---
**Note:** **Note:**
......
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