Verified Commit 4447328f authored by David Haynes's avatar David Haynes 🙆

Dockerize and readmeize

- docs and docker

Closes #28
Closes #26
parent cb0bcb75
# On Contributing
SRCTWeb welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers.
There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.
If you need help at all please contact and SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.
The project lead for this project is **Daniel Bond**. *dbond2@gmu.edu*
Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.
## git
First take a look at [github flow](https://guides.github.com/introduction/flow/)
......
......@@ -2,36 +2,110 @@
Our own little site on the world wide web.
## On Contributing
A static site built with [Jekyll](https://jekyllrb.com/).
SRCTWeb welcomes all the help it can get. Even if you don't feel like you can be helpful the more technical aspects, we definitely need designers, technical writers, and testers.
# Setup instructions for local development
There are many things that can be done with this project (see the "To Do" section), but sometimes it's the small things that count, so don't be afraid of contributing just a small spelling mistake.
## 1) Install `git` on your system
If you need help at all please contact and SRCT member. We want people to contribute, so if you are struggling, or just want to learn we are more than willing to help.
`git` is the version control system used for SRCT projects.
The project lead for this project is **Daniel Bond**. *dbond2@gmu.edu*
### On Linux Based Systems
Please visit the [SRCT Wiki](http://wiki.srct.gmu.edu/) for more information on this and other SRCT projects, along with other helpful links and tutorials.
**with apt:**
## Setup
Open a terminal and run the following command:
To get started, you'll need the following installed:
sudo apt update
* [Git](http://git-scm.com/book/en/Getting-Started-Installing-Git)
* [Jekyll](https://jekyllrb.com/docs/installation/)
This retrieves links to the most up-to-date and secure versions of your packages.
### Clone the srctweb codebase
Next, with:
Now, we're going to clone down a copy of the Go codebase from [git.gmu.edu](https://git.gmu.edu/srct/srctweb),
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
### On Windows
We recommend that if you are on Windows 10 AE (Anniversary Edition) or above to make use of the
Windows Subsystem for Linux (WSL). The following link should get you up and running:
[https://msdn.microsoft.com/en-us/commandline/wsl/install_guide](https://msdn.microsoft.com/en-us/commandline/wsl/install_guide)
#### Contributing with Windows
If you are not on Windows 10 or would rather prefer to not use the WSL you may download Git for
Windows here:
[https://git-scm.com/download/win](https://git-scm.com/download/win)
I have also successfully ran the project with Docker on Windows, though you need
access to Hyper-V which is only available on **"Professional"** versions of Windows.
## 2) Clone the srctweb codebase
Now, we're going to clone down a copy of the SRCTWeb codebase from [git.gmu.edu](https://git.gmu.edu/srct/srctweb),
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).
**[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/srctweb.git
to be continued...
\ No newline at end of file
## 3) Get SRCTWeb up and running with the method of your choice
Now that we have cloned down the repo you can
cd srctweb/
and get to working on setting up a development environment!
### Docker
Installing Docker on your system:
* For macOS go here: https://docs.docker.com/docker-for-mac/
* For Windows go here: https://docs.docker.com/docker-for-windows/
* For your specific linux disro go here: https://docs.docker.com/engine/installation/
* Additionally, you will need to install docker-compose: https://docs.docker.com/compose/install/
Run:
docker-compose up
If that doesn't work, try:
sudo docker-compose up
You should see that the server is running by going to [http://localhost:4000](http://localhost:4000) in your browser. Any changes you make to your local file system will be mirrored in the server.
# Contrubuting
Please read `CONTRIBUTING.md` for specific information and best practices on how
to contribute to the project.
srctweb:
image: jekyll/jekyll
command: jekyll serve -s './srctweb' -d './srctweb/_site' --trace --watch --incremental
ports:
- 4000:4000
volumes:
- .:/srv/jekyll
......@@ -41,7 +41,7 @@ exclude:
# Build settings
markdown: kramdown
gems:
plugins:
- jekyll-feed
defaults:
......
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