Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/LeBenLeBen/cookr
Cookr is a Rails app to manage cooking recipes organized by tags.
https://github.com/LeBenLeBen/cookr
app cookbook cooking rails recipes
Last synced: 4 days ago
JSON representation
Cookr is a Rails app to manage cooking recipes organized by tags.
- Host: GitHub
- URL: https://github.com/LeBenLeBen/cookr
- Owner: LeBenLeBen
- License: gpl-3.0
- Archived: true
- Created: 2014-01-05T15:13:10.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-10-12T18:19:59.000Z (about 3 years ago)
- Last Synced: 2024-08-02T12:49:02.527Z (3 months ago)
- Topics: app, cookbook, cooking, rails, recipes
- Language: Ruby
- Homepage:
- Size: 3.19 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-starred - LeBenLeBen/cookr - Cookr is a Rails app to manage cooking recipes organized by tags. (rails)
README
# Cookr
Cookr is a simple Rails application to manage cooking recipes organized by tags.
## Installation
### Virtualization with [Drifter](https://github.com/liip/drifter)
Vagrant and Virtualbox or Vagrant-LXS are required. Check [Drifter documentation](https://liip-drifter.readthedocs.io/en/stable/) if necessary.
```bash
git clone --recursive [email protected]:LeBenLeBen/cookr.git
cd cookr
vagrant up
```
Wait for the provisioning to complete, then enter the box and start the server.
```bash
vagrant ssh
bundle exec foreman start
```
Go to [cookr.lo](http://cookr.lo).
### Local installation
Ruby >= 2.5, PostgreSQL and [Bundler](http://bundler.io/) are required.
```bash
git clone [email protected]:LeBenLeBen/cookr.git
cd cookr
bundle install
```
#### Setup database
Create the PostgreSQL user (default password is _cookr_):
```bash
createuser cookr -P
```
Create the PostgreSQL database:
```bash
createdb cookr
```
Copy the database configuration file (PostgreSQL):
```bash
cp config/database.example.yml config/database.yml
```
Update it to match your settings, then load the schema into the database:
```bash
rails db:migrate
```
#### Start the server
```bash
bundle exec foreman start
```
Go to [localhost:5000](http://localhost:5000).
## Create a user
Registrations are disabled. You can use the console (`rails c`) to create a new user.
```ruby
User.create(email: '', password: '', password_confirmation: '')
```
## Enable search
The search work through [Algolia](https://www.algolia.com/). To enable it you need to:
- Have an Algolia account
- If the `.env` file doesn’t already exists, copy `.env.example` to `.env`
- Fill in the variables `ALGOLIASEARCH_APPLICATION_ID`, `ALGOLIASEARCH_API_KEY` and `ALGOLIASEARCH_API_KEY_SEARCH` according to the values you’ll find in your Algolia dashboard
- Index data with `rake algoliasearch:reindex`
Note: indexing will automatically create new Algolia indices in the form `Model_environment`, for example `Recipe_development`.
## License
Cookr is licensed under [GPL version 3](http://www.gnu.org/copyleft/gpl.html).