Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.33 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.33 KB
Raw

Redirect

This is a simple Node app that allows us to serve shortlinks that redirect places and retain ownership of our data. We run it on Heroku and serve links at https://c4a.me/. This software is in beta: it works pretty well, serves our needs, but could use some improvement. See our repo issues if you'd like to help improve it.

Note: The master branch of this repo automatically deploys to Heroku if it passes tests.

What it does

Redirect reads links in redirects.json and redirects visitors to the right place.

Adding links

Branch or fork, add a new key/value pair in redirects.json and submit a Pull Request.

What it uses

  • Node
  • Mixpanel for analytics (set environment variable MIXPANEL_TOKEN)

How to install and run locally

git clone https://github.com/codeforamerica/redirect.git
cd redirect
npm install
npm start

How to run tests

npm test

Tests currently check to make sure the redirects.json file is valid JSON, and that the application serves redirects for each line in the file correctly.

License

This software is Copyright (c) 2015 Code for America, and released under the MIT License. Please see LICENSE for details.