An open API service indexing awesome lists of open source software.

https://github.com/xsidx/recipe_app


https://github.com/xsidx/recipe_app

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Recipe App

> This is a A rails application that allows users to add foods, create a recipe and generate a shopping list of missing stock. It includes user authentication and data is preserved using postgresql.

## Built With

- Ruby on Rails

## Getting Started

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

### Live Demo
[Recipe App](https://sid-ck-recipe-app.herokuapp.com)

### Prerequisites

- Ruby runtime environment
- Postgresql
- Rails

### Setup

- Clone the repository using `git@github.com:XsidX/recipe_app.git`
- Navigate to the folder using `cd recipe_app`
- Use the following commands to
- install necessary gems `bundle install`
- run `rails assets:precompile`
- run the development server `./bin/dev`

### Testing
- run `rails assets:precompile` before running the tests
- to run the tests, do: `rspec`

## Author

👤 **Sidney**

- GitHub: [XsidX](https://github.com/XsidX)
- Twitter: [@\_sid_o](https://twitter.com/_sid_o_)
- LinkedIn: [Sidney Kaguli](https://www.linkedin.com/in/sidney-kaguli)

👤 **Chrispaix Kaze**

- GitHub: [@Chrispaix Kaze](https://github.com/ChrispaixK)
- Twitter: [@Chrispaix Kaze](https://twitter.com/ChrispaixK)
- LinkedIn: [Chrispaix Kaze](https://www.linkedin.com/in/chrispaix-kaze-70445a175/)
## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

## Show your support

Give a ⭐️ if you like this project!

## Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- etc

## 📝 License

This project is [MIT](https://github.com/XsidX/recipe_app/blob/additional-fixes-and-features/MIT.md) licensed.

NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._