Skip to content
This repository has been archived by the owner on Jan 5, 2019. It is now read-only.

Latest commit

 

History

History
72 lines (47 loc) · 2.45 KB

README.md

File metadata and controls

72 lines (47 loc) · 2.45 KB
Raw

Go Web Masters Website

The official website for the #GoWebMasters Slack Group's website: GoWebMasters.club

The site is published using Jekyll, and hosted on GitHub Pages.

Installation

You can set up a local version of the site to test changes. We highly recommend installing Jekyll to preview and help troubleshoot failed builds.

Follow the detailed instructions provided by Github for local setup.

Vagrant Installation

If you're running a Windows OS, the Vagrant installation is the easiest approach.

Vagrant will create a virtual machine, provision it with Jekyll and all its dependencies, forward port 4000 to your host OS and synchronize the repository directory with a /vagrant directory inside the virtual machine. This allows you to use your favourite IDE on your host OS.

  • Install Vagrant
  • install Vagrant Exec: vagrant plugin install vagrant-exec
  • Open a terminal (cmd on Windows)
    • git clone <this_repo>
    • cd <this_repo>
    • vagrant up then wait for Vagrant to finish provisioning the virtual machine

Running Server

To start serving the website

$ vagrant exec server

To ssh into the machine and serve the website (Windows: you will need a valid SSH key setup with Vagrant):

$ vagrant ssh
$ cd /vagrant
$ server

on Windows, you might need PuTTY

The website will be available on http://localhost:4000.

Contributing

  • Fork this repository on GitHub
  • git clone <your_fork>
  • git checkout -b feature-branch-name where feature-branch-name describes what your change will be
  • Make the necessary changes
  • Thoroughly test your changes
  • git commit -am "this is what I did"
  • git push -u origin feature-branch-name
  • Create a pull request on GitHub

Rules for Contributing

  • Please maintain the same the same code style as the rest of the code base.
  • One pull request per feature.

Deployment

Simply push to GitHub and GitHub Pages will automatically build (assuming your pull request is approved)

License

The MIT License (MIT). See LICENSE for more details.