Shimi / openspace

An open source app to showcase your open source work (yo dawg)

Home Page:http://everythingme.github.io/openspace

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Openspace

Openspace is a web app to showcase your open source projects on GitHub.

We’ve reached a point where EverythingMe's organization profile on GitHub holds a combination of internal tools, forks of projects we’re using and contributed to and some less interesting bits. We wanted a simple and beautiful way to showcase the projects that are represent our open sourced work.

Shut up and show me how it looks

Overview

The web app is purely static to allow it to be hosted on GitHub pages, it uses a projects.json under /data folder to determine which projects to display.

While iterating on the design and metadata we're displaying, we created a tool to populate the projects.json file and also update it (in case you want periodic updates for descriptions / stars and forks counts).

Getting Started

  • Clone and push to username.github.io repo.
  • Use the data tool to create your projects.json file.
  • Modify the projects.json if needed and test locally (simplest way to run it is to run python -m SimpleHTTPServer in the root folder and browse to http://localhost:8000
  • Push. Profit.

Acknowledgements

License

See LICENSE file.

About

An open source app to showcase your open source work (yo dawg)

http://everythingme.github.io/openspace

License:Apache License 2.0


Languages

Language:JavaScript 67.2%Language:HTML 30.0%Language:CSS 1.6%Language:Python 1.0%Language:Ruby 0.1%Language:Shell 0.1%Language:Batchfile 0.0%