DOCUMENTATION
INTRODUCTION
Overview Getting Started
BASICS
Entries Software Design
GUIDES
Contributing Guide Writing Entries Development Workflow GitHub ELI5
TUTORIALS
Adding Entries Editing Entries Installing Locally
 
Introduction
Overview Getting Started
Basics
Entries Software Design
Guides
Contributing Guide Writing Entries Development Workflow GitHub ELI5
Tutorials
Adding Entries Editing Entries Installing Locally
This page is still a draft

Please consider editing this file on GitHub. You can follow the editing tutorial

Last edit: 26-Feb-18

Installing Locally

Working locally in your computer makes editing the project very simple and makes previewing changes possible. We recommend downloading GitHub Desktop as a Git client (available for MacOS and Windows), and Atom as a text editor (MacOS, Windows and Linux).

Installation on MacOS

  1. Install command line tools: open a terminal (found in /Applications/Utilities/) and copy/paste the following line into the Terminal 
    xcode-select --install

    A popup window will appear, select ‘Install’

  2. Install rvm with ruby: copy/paste the following line into the Terminal 
    \curl -sSL https://get.rvm.io | bash -s stable --ruby
  3. Install Bundle: copy/paste the following line into the Terminal 
    gem install bundler
  4. Clone the repository: Go to the sphere repository and select ‘Clone or download’ green button and then select ‘Open in Desktop’. It should open GitHub Desktop in your computer. Select a location for the folder
Fork first if you are not a member

If you are not a member of diybiosphere community, you will have to ‘fork’ first the repository and then follow these steps with your forked repository.

  1. Open sphere folder in terminal: open GitHub Desktop and make sure the current repository open is the sphere repository or your forked repository. In the top menu, select ‘Repository>Open in Terminal’
  2. Install dependencies: copy/paste the following line into the Terminal 
    bundler install

    Once in a while it helps to run bundler update

  3. Start server: copy/paste the following line into the terminal 
    jekyll serve --incremental

    This will start a server on your computer which you can preview at the address printed in the terminal after the command runs.

  4. Make changes to the files: open GitHub Desktop. In the top menu, select ‘Repository>Open in Atom’. Anytime you make changes to the files and save them. the jekyll server will rebuild the file.
Make changes to a branch

If you are making many changes, consider creating a new branch or adding to an existing one

Installation on Windows

This section is still incomplete. Please consider adding content if you can!!

Installation on Linux

This section is still incomplete. Please consider adding content if you can!!

Comments

Open Comments Issue in GitHub