Mikanebu/data.okfn.org-new

This repo performs a few different purposes:

An issue tracker for Frictionless Data (http://data.okfn.org/) activities
Source repo for documentation for Frictionless Data project (docs themselves deployed at http://data.okfn.org/doc/)
The simple NodeJS app that runs the http://data.okfn.org website

Installing the App

1. Install dependencies

Requires NodeJS (>= v0.8).

Install the requirements (in package.json):

npm install .

Configure

This is optional - the app will work out of the box with the default configuration (see lib/config.js).

You can configure the app by setting environment variables:

CATALOG_LIST: a URL to a Data Package Catalog List - a txt file with each line being a URL to a Data Package. See e.g. http://raw.github.com/datasets/registry/master/catalog-list.txt
CORE_CATALOG_LIST same as previous but points to list of Core Data Packages e.g. http://raw.github.com/datasets/registry/master/datapackage-list.txt

Run the web application

Run the web app locally:

node app.js

If you want to do a deployment to Heroku see the next section.

Deployment to Heroku

Note that you will need to install the Heroku toolbelt to carry out the heroku commands below.

Create the application on Heroku

Skip this step if the application is already deployed

This is heavily based on this tutorial.

# replace {app-name} with the name of your app
heroku create {app-name}
git push heroku master
# now point at our config
heroku ps:scale web=1

To deploy (already created):

Push to heroku git repo:

git push heroku master

Note: if didn't do the create you will need to add the heroku remote:

git remote add heroku git@heroku.com:{app-name}.git

Adding collaborators:

heroku sharing:add joe@example.com

Setting the domain name

Do the following:

heroku domains:add {your-domain-name}

Now CNAME your domain to {myapp}.herokuapp.com

License

Licensed under the MIT license:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Mikanebu / data.okfn.org-new