Table of Contents

• About the Project
  • Built With
    • Tech Stack
    • Key Features
  • Live Demo
• Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• Authors
• Future Features
• Contributing
• Show your support
• Acknowledgements
• FAQ
• License

[your_project_name]

Describe your project in 1 or 2 sentences.

[your_project__name] is a...

Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Key Features

Describe between 1-3 key features of the application.

• [The app allows users to add recipes and foods]
• [It also allows users to declare recipes as public or private]
• [It allows users to plan shopping list]

Live Demo

Add a link to your deployed project.

• Live Demo Link

Getting Started

Describe how a new developer could make use of your project.

To get a local copy up and running, follow these steps.

Setup

Clone this repository to your desired folder:

Install

Install this project with:

• Run:

Bundle Install
rails db:drop
rails db:create
rails db:migrate

To include bootstrap in the project and avoid bootstrap-related errors, run the following commands...

./bin/rails css:install:bootstrap
./bin/rails javascript:install:esbuild
yarn add @hotwired/turbo-rails
yarn add @hotwired/stimulus

THen, start the app with...
rails s

Run tests

To run tests, run the following command:

Rspec

Authors

Mention all of the collaborators of this project.

Kehinde Ridwan

• GitHub: @kendoriddy
• Twitter: @RideOnOne09
• LinkedIn: Kehinde Onifade

Anas Chaabane

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Write a message to encourage readers to support your project

If you like this project...

Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.