Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codingitwrong/firehose-api
Backend for an open-source web app for link saving and sharing.
https://github.com/codingitwrong/firehose-api
json-api links rails
Last synced: 9 days ago
JSON representation
Backend for an open-source web app for link saving and sharing.
- Host: GitHub
- URL: https://github.com/codingitwrong/firehose-api
- Owner: CodingItWrong
- License: other
- Created: 2017-11-05T12:03:14.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T12:55:45.000Z (21 days ago)
- Last Synced: 2025-01-16T14:20:20.307Z (21 days ago)
- Topics: json-api, links, rails
- Language: Ruby
- Homepage:
- Size: 4.08 MB
- Stars: 10
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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](https://github.com/CodingItWrong/firehose-web) available.
An [iOS share extension app](https://github.com/CodingItWrong/Hydrant) is also available.
## Getting Started
### Requirements
1. Ruby
1. PostgreSQL (e.g. [Postgres.app][postgres-app])
1. 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
```sh
$ bin/rspec
```
### Running
```sh
$ 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](https://devcenter.heroku.com/articles/getting-started-with-rails5).
## Attribution
“[Fire Hose](https://thenounproject.com/term/fire-hose/14726/)” by [Alv Jørgen Bovolden](https://thenounproject.com/Alvbovo/) is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
## License
Apache
[postgres-app]: http://postgresapp.com
[foreman]: https://github.com/ddollar/foreman