hqrshguptq / opensourcedesign.github.io

:art::computer: source code of our website

opensourcedesign.net

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

Edit Website

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

1. Using GitHub's nifty file editor

2. Modifying source code (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:

• Jekyll
• Bootstrap

Installing

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

• Installing Ruby
• Using GitHub with SSH

1. Install Jekyll using and other Ruby gems

sudo gem install bundler

2. 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

3. Run our installer script

This will pull down all of the repositories (jobs, events, etc...) and put them in there proper place to build our website locally.

./scripts/install.sh

Note: you need to be a member of our GitHub organization.

4. Build the static site & watch for files

bundler exec jekyll serve --watch --config _config.yml,_config-dev.yml

Updating

Updating the various repositories can be done by running this script

./scripts/update.sh

👩‍🚀 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. Your logo will show up here with a link to your website. (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.