Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/newhoteng/recipe-app
https://github.com/newhoteng/recipe-app
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/newhoteng/recipe-app
- Owner: newhoteng
- License: mit
- Created: 2023-07-31T07:59:51.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-11T21:52:27.000Z (over 1 year ago)
- Last Synced: 2024-10-23T19:23:34.226Z (2 months ago)
- Language: Ruby
- Homepage:
- Size: 161 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 *Table of Contents*
- [📖 About the Project](#about-project)
- [🛠️ Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
# :open_book: Recipe-app
Recipe-app is an app keeps track of all your recipes, ingredients, and inventory. It will allow you to save ingredients, keep track of what you have, create recipes, and generate a shopping list based on what you have and what you are missing from a recipe. Also, since sharing recipes is an important part of cooking the app allows you to make them public so anyone can access them.
Backend
Database
### Key Features
- List of foods
- Ability to add new food
- Ability create a recipe
- List of recipes
- Ability to create shopping list based on list of foods and recipes
## :computer: Getting Started
To get a local copy up and running, follow these steps.
### Prerequisites
You need the following tools be installed in your computer:
- [Rails](https://guides.rubyonrails.org/)
- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
- [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
- IDE
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/newhoteng/Recipe-app.git
```
### Install
Install this project with:
```sh
cd Recipe-app
bundle install
```
### Database
Create the databases and run migrations with:
```sh
rails db:create
rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
rails server or rails s
```
### Run tests
To run tests, run the following command:
```sh
rspec spec/
```
## :busts_in_silhouette: Authors
:bust_in_silhouette: **Harriet Oteng**
- GitHub: [@githubhandle](https://github.com/newhoteng)
- Twitter: [@twitterhandle](https://twitter.com/HarrietOteng1)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harriet-oteng-75554666/)
:bust_in_silhouette: **Kibrewossen Y Mekasha**
- GitHub: [@akos29](https://github.com/akos29)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/kibrewossen-y-mekasha/)
## :telescope: Future Features
- Improve styling
## :handshake: Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/newhoteng/Recipe-app/issues).
## :star: Show your support
If you like this project give it a star.
## :pray: Acknowledgements
- Thanks to our standup team.
## :memo: License
[License](https://github.com/newhoteng/Recipe-app/blob/main/LICENSE)