Skip to content

opensourcedesign/opensourcedesign.github.io

Repository files navigation

Website of the Open Source Design community, hosted on GitHub Pages.

Backers on Open Collective Sponsors on Open Collective Twitter Follow Gitpod ready-to-code

Edit Website

Editing content on opensourcedesign.net can be done in 3 ways, all of which require a GitHub account.

  1. Using GitHub's nifty file editor, which is quick but limited:

  2. Using Gitpod which gives you a preconfigured IDE and live preview. This is quick and you can see your changes:

  3. Setting the website up locally, which is more technical.

Code & Design The Website

You need some basic ability to use a terminal as well as some knowledge of web development like HTML, CSS, and JavaScript. The site is built with the following programming tools:

Installing

This step requires having a ruby development environment and git installed and configured to connect to GitHub with SSH.

  1. Install Jekyll using and other Ruby gems. Find out more on https://jekyllrb.com/docs/

e.g. Jekyll requires the following: Ruby version 2.5.0 or higher RubyGems GCC and Make

sudo gem install bundler
  1. Fork and clone the main website repository
git clone --single-branch --branch master https://github.com/opensourcedesign/opensourcedesign.github.io.git
cd opensourcedesign.github.io/
bundle install
  1. Clone the jobs repository

Currently the job board is still a separate repository, but we plan to move it in here.

git clone https://github.com/opensourcedesign/jobs.git
  1. Build the static site & watch for files
bundler exec jekyll serve --watch --config _config.yml,_config-dev.yml

πŸ‘©β€πŸš€ Contributors, backers & sponsors

This project exists thanks to all the people who contribute.

Thank you to all our backers! πŸ™ (Become a backer)

Support this project by becoming a sponsor. (Become a sponsor)

β™₯ Code of Conduct

Please note that Open Source Design has a Contributor Code of Conduct. By participating in this project online or at events you agree to abide by its terms.

πŸ“œ License

πŸ”€ You can use & modify everything as long as you credit Open Source Design and use the same license for your resulting work. Code license is AGPLv3 and content is Creative Commons Attribution-ShareAlike.