https://github.com/timbar09/recipe_app-rails
https://github.com/timbar09/recipe_app-rails
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/timbar09/recipe_app-rails
- Owner: Timbar09
- Created: 2023-05-22T10:05:56.000Z (almost 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-05-25T11:36:11.000Z (almost 3 years ago)
- Last Synced: 2025-04-06T22:27:18.938Z (12 months ago)
- Language: Ruby
- Size: 689 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Microverse README Template
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[Recipe 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.
## 🛠 Built With
- Ruby
- Ruby on Rails
- Postgresql
- VScode
### Tech Stack
- Ruby
- Ruby on Rails
- Postgresql
- Embedded Ruby
> Describe the tech stack and include only the relevant sections that apply to your project.
Client
Server
Database
> Describe between 1-3 key features of the application.
- **[Create a recipe]**
- **[Create foods that can be cooked using recipes]**
- **[Shopping List]**
> Add a link to your deployed project.
- [Live Demo Link](https://google.com)
**This is an example of how you may give instructions on setting up your project locally.**
**Modify this file to match your project, remove sections that don't apply. For example: delete the testing section if the currect project doesn't require testing.**
To get a local copy up and running follow these simple example steps.
### Prerequisites
- A code editor (like Atom, VScode...).
### Setup
To setup the project locally: clone the repository using:
```
git@github.com:Timbar09/recipe_app-rails.git
```
### Install
run: `rails server`
### Usage
### Run tests
run: rspec
### Deployment
login: `localhost:3000`
## 👥 Authors
👤 **Ogaga Iyara**
- GitHub: [@githubhandle](https://github.com/Ogaga01)
- Twitter: [@twitterhandle](https://twitter.com/i_ogaga_n)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/ogaga-iyara-0339b0105/)
> Describe 1 - 3 features you will add to the project.
- [ ] **[new_feature_1]**
- [ ] **[new_feature_2]**
- [ ] **[new_feature_3]**
CContributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project!.
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
This project is [MIT](./LICENSE) 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._