CodingItWrong / firehose-api

Backend for an open-source web app for link saving and sharing.

firehose-api

An open-source web service API for link saving and sharing. Allows you to own your data.

To make use of this API, you'll need a frontend. There is currently a React web frontend available.

An iOS share extension app is also available.

Getting Started

Requirements

1. Ruby
2. PostgreSQL (e.g. Postgres.app)
3. Redis

Setup

The .env file at the root of the project is used by the Rails backend and includes connectivity info. Duplicate the file .env.sample, rename it to .env, and fill in the values.

Testing

$ bin/rspec

Running

$ bin/serve

Deployment

One easy way to deploy Firehose is Heroku. There is a Free tier whose only limit is that the app sleeps after 30 minutes of inactivity.

To deploy to Heroku, follow Heroku’s instructions on deploying a Rails app.

Attribution

“Fire Hose” by Alv Jørgen Bovolden is licensed under CC BY 3.0

License

Apache