Skip to content

Latest commit

 

History

History
executable file
·
55 lines (44 loc) · 3.29 KB

README.md

File metadata and controls

executable file
·
55 lines (44 loc) · 3.29 KB

Recipe-API

The purpose of API repository of full stack web application is to support the recipe-client(frontend) application for the user to interact with. This app allows the user to create, update, delete and view the foods that users have created.

API link and the Main Reason

The main reason behide this project was from my inspiration and passion of cooking, which I have been cooking for the past 18 years as my profession. I want to keep all the recipes from my own experience and write it down where I can share with whoever have a passion in cooking. The most important thing is the users itself to be able to create their own and share with other. The extra features of this app is allows the users to update and delete their own items. API deployed: https://enigmatic-tor-32625.herokuapp.com/ API repo: https://github.com/subdit/recipe-api

Client Repository

Recipe-client: https://subdit.github.io/recipe-client/

Wireframe

This wireframe or ERD (Entity Ralationship Diagram). This project can be expended from version 1 to version 2(one to many and many to many) and version 3 which I did not include in this project. link: https://imgur.com/DYDJPIK

Planning

I start with Download the template and make sure that you have right version to be able to support all the new update features of the tools that you use. When I finish setup and tested the recipe-api I moving to recipe-client side. Remeber => go slow, one stept at the time.

rails-api-template

I start with Download the template from the links below : https://git.generalassemb.ly/ga-wdi-boston/rails-api-template/archive/master.zip rails-api-examples-walkthrough: : https://git.generalassemb.ly/ga-wdi-boston/rails-api-examples-walkthrough

The challenging

My most challenging was setup the template. I have downloaded the older version and my code was broken. Tips: run the test in curl script that will help you to be able to fix and debugging in the development side before you deploy to the production side.

Dependencies Install

The API setup need to install "bundle install" and follow the links below. rails-api: https://github.com/rails-api/rails-api rails: https://github.com/rails/rails active_model_serializers: https://github.com/rails-api/active_model_serializers ruby: https://www.ruby-lang.org/en/ postgres: http://www.postgresql.org

lists of technology use

The main framework is built on Ruby and support by rails that host by Heroku. I separate this database out in 2 table, one is for the user and one is for foods. Users table has a relationship with many_food. I can expend this project. For example..I can add more tables(recipe, ingredients) and give the user table have more access to new recipe, ingredients table then I can setup the relationship of the recipe table belongs_food table and food table has_many recipes,. etc.

Additional Resources

To install rails-heroku-setup-guide follow these links below. : https://git.generalassemb.ly/ga-wdi-boston/rails-heroku-setup-guide : http://guides.rubyonrails.org/api_app.html : https://blog.codeship.com/building-a-json-api-with-rails-5/

  1. All content is licensed under a CC­BY­NC­SA 4.0 license.
  2. All software code is licensed under GNU GPLv3. For commercial use or alternative licensing, please contact legal@ga.co.