sieb / gridcoin-site

Open source Gridcoin website

Gridcoin-Site

Open source Gridcoin website

Building Locally

This uses the Jekyll Site builder

For installation of Jekyll, please follow the installation guide for your operating system.

Build Locally & Contributing

Ubuntu Linux guide

1. Fork this repository by clicking the fork button (top right)

2. sudo apt-get install git if you don't already have git installed

3. git clone https://github.com/gridcoin-community/Gridcoin-Site.git (replace this with your fork)

4. cd Gridcoin-Site

5. Runbundle install (preps the web server for local previewing)

6. git branch your_branch_name (give it a descriptive name like "whitelist changes") followed by git checkout your_branch_name

7. Every time you make changes, run git commit -a to add your changes followed by git push to push them to your repo on github.com. The first time you push, you'll need to run git push --set-upstream origin your_branch_name first to let Github.com know about your new branch.

8. You can preview your changes with a local development server by running bundle exec jekyll serve

9. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.

Windows guide

1. Fork this repository by clicking the fork button (top right)

2. Install Git for windows

3. Use Git GUI to clone gridcoin Repo --OR-- Go to the location you store Git Repos and Rightclick -> Gitbash here, then run git clone https://github.com/gridcoin-community/Gridcoin-Site.git (put your fork's URL here)

4. Go to Gridcoin-Site folder (or whatever you specified when pulling the repo) Shift+RightClick -> Open Cmd Prompt Here or Open Powershell window here(Win 10)

5. Run bundle install (preps the web server for local previewing)

6. git branch your_branch_name (give it a descriptive name like "whitelist changes") followed by git checkout your_branch_name

7. Every time you make changes, run git commit -a to add your changes followed by git push to push them to your repo on github.com. The first time you push, you'll need to run git push --set-upstream origin your_branch_name first to let Github.com know about your new branch.

8. You can preview your changes with a local development server by running bundle exec jekyll serve

9. When ready to submit changes, go back to your fork on github.com and you will be prompted to make a pull request.

Editing Specific Sections

Want to edit the wiki?

See more information about that process here

Interested in contributing towards the whitelist?

Head on over to the data folder to get more info.

How to Update gems

Delete Gemfile.lock and run bundle install

For running the development web server

bundle exec jekyll serve

WSL notes

If you're running through WSL you need to use the flag --force-polling with the above command or it will not regenerate automatically on changes.

If you wish to access it from another device you need to use this workaround. Remember to change the ports that are opened.