This is a website with a map of food sources in Beijing. The master branch of this repo contains source files. The website is hosted in gh-pages branch at https://map.hankso.site or https://hankso.site/foodoasis.bj
Forked and modified from Food Oasis Los Angeles.
- How to make changes
- How to develop locally
- Speeding up Jekyll
- Handy guides
- A summary of the project files
- How to add a new location
- License
The website is published with GitHub Pages, and the files are generated with Jekyll. As you make changes and commit/push them to gh-pages branch on GitHub, the website will automatically update.
If you want to see a preview of your changes while you work, you can run a Jekyll server on your local machine. Installing Ruby and Jekyll is a good place to start.
After you have Jekyll installed, you can clone this project with Git or GitHub Desktop…
git clone https://github.com/hankso/foodoasis.bj.git
And then start running the Jekyll application like this...
jekyll serve
Since it takes a while to generate the whole site, you may want to run Jekyll in “incremental“ mode, and use our development configuration file…
jekyll build && jekyll serve --config _config_dev.yml --incremental
Wow, that’s a lot to remember! We’re using Node.js to manage commands like that one for us. If you’d like to do that as well, here are some steps you can follow…
-
Install Node.js and NPM.
-
Install our project’s dependencies...
npm install
- Start the application...
npm start
That will start Jekyll with a special configuration that skips these files (since they take a long time to create)…
api/*
locations/*
community-garden/*
farmers-market/*
food-pantry/*
summer-lunch/*
supermarket/*
sitemap.xml
If those folders are already present, your local website should still work great (though the files in those folders may not be the latest).
Here’s one more command skips the initial build of those folders, if you want to start up quickly.
npm run serve
_config.yml
_config_dev.yml
_data/*
_drafts/*
_includes/*
_layouts/*
package.json
_node/*
Files generated by Node.js, for Jekyll
_locations/*
_community-garden/*
_farmers-market/*
_food-pantry/*
_summer-lunch/*
_supermarket/*
README.md
LICENSE
CNAME
assets/css
assets/images
assets/js
index.html
organizations.md
resources.md
about.md
team.md
faqs.md
news.html
add.md
404.md
zh/*
locations/*
community-garden/*
farmers-market/*
food-pantry/*
summer-lunch/*
supermarket/*
You can add a new location with the add form.
If you want to add a lot of new locations at once, these files may help…
_node/create-markdown.js
_node/update-markdown.js
After you add one or more new locations, run this command to add them to the map…
npm run update-paging
The markdown files in these folders were initially generated by Node.js from the data files in the _data folder.
_locations/*
_community-garden/*
_farmers-market/*
_food-pantry/*
_summer-lunch/*
_supermarket/*
They were created with _node/create-markdown.js and updated with _node/update-markdown.js, but have since been edited by hand.
The code, data and design for this project are available under an open source license. That means you’re free to use them to make a food oasis for your city.
The Food Oasis Beijing name and logo are copyright Hankso. Please check with us first, before using these on a project.
The icons used in this project came from these two sources…
Licensed under Creative Commons
To use these icons on your project, you may need to purchase a license from the Noun Project.