Skip to content

MissionBit/showcase

Repository files navigation

showcase.missionbit.org

This is the source for showcase.missionbit.org! We use Jekyll to help us generate showcase.missionbit.org because that's what GitHub Pages uses. This lets us build a site with a lot of pages without having to repeat so much over and over.

We use the following JavaScript, CSS, and font libraries to make the site work well and look good:

Setup

The most straightforward way is to install Docker Desktop, which takes care of managing the software required to build the site.

HACKING

Open a Terminal and change to the directory where you've checked out showcase, then run this command to start the Jekyll preview server:

docker-compose up

This will run a webserver on your computer at http://127.0.0.1:4001/ and automatically rebuild the site when you make changes to the files. You will have to reload the pages in your browser to see the changes.

You can stop the server by pressing Ctrl-C.

You can run the tests locally with the following command:

docker-compose -f docker-compose-ci.yml up

Using the page template

There's only one page template on the site right now, index.html. It needs some CSS to look better. This is why there is no global _layout or _include folders.

Everything else is just static content placed in sensibly named directories such as 2014/spring/adventure.

Adding a new assignment to the showcase

  • Create a new sensibly named directory for projects in that assignment, and put the projects in that direcotry. See the existing directory structure for examples.
  • Edit _data/assignments.yml and add a description of the assignment, as well as the list of student projects for that assignment.

Netlify Deployment

The site is deployed by Netlify for both production and PR deployment previews.

The Netlify dashboard is at app.netlify.com/sites/missionbit-showcase/overview. Contact [email protected] or [email protected] if you need access to this team for some reason.

DNS is currently hosted by Cloudflare (missionbit.com) or Azure (missionbit.org, missionbits.com, missionbits.org). We may choose to consolidate these or move them to Netlify.

About

Showcase for Mission Bit student projects

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published