https://github.com/tiagomenegaz/fetch-recipes
Fetch Recipes from Contentful APIs
https://github.com/tiagomenegaz/fetch-recipes
docker docker-compose rails5 redis sidekiq
Last synced: 3 months ago
JSON representation
Fetch Recipes from Contentful APIs
- Host: GitHub
- URL: https://github.com/tiagomenegaz/fetch-recipes
- Owner: tiagomenegaz
- License: mit
- Created: 2019-07-23T03:02:43.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-19T13:54:11.000Z (over 3 years ago)
- Last Synced: 2025-05-16T16:11:36.683Z (about 1 year ago)
- Topics: docker, docker-compose, rails5, redis, sidekiq
- Language: Ruby
- Homepage:
- Size: 4.78 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fetch Recipes
This README includes everything necessary to get the application up and running.
Fetch Recipes is totally supported with Docker so make sure you have it propertly configured and installed. At the moment, the whole project is configured for development purposes.
### Getting Started
Make sure you've copied and renamed your `.env.sample` to `.env`.
The first time running this project you should run:
```
docker-compose pull &&
docker-compose run --rm app bundle install &&
docker-compose run --rm worker bundle install
```
Now, you can run the following command to run all project's dependencies:
```
docker-compose pull &&
docker-compose run --rm app rake db:create &&
docker-compose run --rm app rake db:migrate &&
docker-compose run --rm worker rake populate:space &&
docker-compose up
```
There are some useful commands that you might need to use:
```
docker-compose run --rm app rails c
docker-compose run --rm app rake db:drop db:create db:migrate
```
### Introduction
This project has two main pages
#### Recipes Index List view / Root
Display a preview of all recipes, including:
- Title
- Image
#### Recipes Details View
Display all the data for a recipe:
- Title
- Image
- List of Tags
- Description
- Chef Name
### How the project is structured?
This project has two main structures as you can see in the Docker-Compose file. The first called app, and it contains everything that a user can see when accessing the application itself. The second is called worker and contains what is necessary to collect data from the source (Contentful). This approach allows worker tasks to run parallel with any user accessing the system.
### Highlights
* Fully Dockerized
* Separation between User application and background jobs
* Service Pattern usage
* Clean UI
* Clean code
### Future Improvements
Software is a continous process and some improvements might be done in the future
* Add deployment configuration
* Add pagination at main page
* Improve application layout