redirect's Introduction

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

redirect's Issues

Images for README

This issue is to host our README images.

Add a license file

Without a license, this project isn't open source and no one can use the code.

Please use something like http://choosealicense.com/ to decide what license to use. I recommend MIT or GPL.

Linking with www does not work

Just discovered this as a bug in our usage — for us:

http://c4a.me/balance works
www.c4a.me/balance gives a Heroku "no such app" error

This isn't a huge problem for us specifically since we can fix it, but my guess is some people are circulating www without realizing it doesn't work and will get silent errors.

Recommend Projects