Skip to content

Latest commit

 

History

History
125 lines (80 loc) · 3.13 KB

README.md

File metadata and controls

125 lines (80 loc) · 3.13 KB
Raw

Project Name

My Recipe App

Description the project.

This is a Ruby on Rails app that allows user to create, delete, and read recipes created by them or the community, allowing the users to decide whether they'd be public or not. Additionally, it allows users to create food records and generate a shopping list based on the missing food for their recipes. It comes with authentication and authorization functionality.

foods recipe public genera image

Live Link

Live-demo

Built With

  • Languages: Ruby Postgresql
  • Frameworks: Ruby On Rails
  • Technologies used: Visual Studio Code

Requirements

In order to work on this project, you need to have the following dependencies installed:

Getting Started

Clone this repository

$ git clone git@github.com:Lizdev-05/Recipe-app.git
$ cd recipe-app

Commands to run

Run

$ bundle install

To get all the gems required for the project

Then, run

$ npm install

To install packages such as style linters

To check linters locally, use

$ rubocop
$ npx stylelint "**/*.{css,scss}"

Once you have the project correctly set up, run

$ bin/rails db:setup

To run all migrations, create the database for testing and for development, and insert some data into the database for you to visualize the changes

Finally, each time you make changes to the project, run

$ bundle exec rspec /spec

In the root folder to check the consistency of the app. Please don't make changes to the tests unless completely necessary, and mention it in your PR description.

Important note: Since this project uses TailwindCSS for the styling, you need to run:

$ ./bin/dev

For you to see the styling being applied in the browser during development

Authors

👤 Ojesanmi Elizabeth Oyin

👤 Hamma Azarok

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Microverse
  • LazyCoders
  • Coding Partners
  • Inspiration
  • etc

📝 License

This project is MIT licensed.