Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mnisarali/recipe_app
The Recipe app efficiently manages recipes, ingredients, and inventory. Save ingredients, track availability, create recipes, and generate shopping lists. Share recipes publicly for easy access by all users.
https://github.com/mnisarali/recipe_app
authorization crud devise psql recipe-app rspec ruby-on-rails
Last synced: about 6 hours ago
JSON representation
The Recipe app efficiently manages recipes, ingredients, and inventory. Save ingredients, track availability, create recipes, and generate shopping lists. Share recipes publicly for easy access by all users.
- Host: GitHub
- URL: https://github.com/mnisarali/recipe_app
- Owner: MNisarAli
- License: mit
- Created: 2023-10-09T08:08:03.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-31T05:17:58.000Z (11 months ago)
- Last Synced: 2025-01-08T09:52:53.378Z (about 6 hours ago)
- Topics: authorization, crud, devise, psql, recipe-app, rspec, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 736 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[ ](https://rubyonrails.org/)
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [👨💻 Recipe App ](#-recipe-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Running the App](#running-the-app)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**The Recipe App** allows you to easily manage your recipes and ingredients. You can save ingredients, track your stock, create new recipes, and generate a shopping list based on your needs. The app also encourages recipe sharing, with the option to make them public for everyone to enjoy.
Server
Database
The key features of this project include.
- **Manage recipes and ingredients**
- **Save and organize ingredients**
- **Create and develop new recipes**
- **Generate shopping lists based on recipe needs**
- **Option to make recipes public for everyone to access**
To get a local copy up and running, follow these steps.
### Prerequisites
Before you begin, make sure you have the following installed on your machine:
- [x] Ruby: You can download Ruby [here](https://www.ruby-lang.org/en/downloads/).
- [x] Rails: You can install Rails by running the command `gem install rails` in your terminal.
- [x] A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode [here](https://code.visualstudio.com/download), Sublime [here](https://www.sublimetext.com/3), and Atom [here](https://atom.io/).
- [x] Git: You can download Git [here](https://git-scm.com/downloads).
- [x] Node.js: You can download Node.js [here](https://nodejs.org/en/download/).
### Setup
To setup this project locally:
1. Open terminal in VScode.
2. Navigate to the directory where you want clone the copy of this repository.
3. Create new directory [optional].
4. Clone the repository by running the following command:
```
git clone [email protected]:MNisarAli/recipe_app.git
```
5. Navigate into the cloned repository:
```
cd recipe_app
```
### Installation
Install the required dependencies by running the following command:
```
bundle install
```
### Database Setup
To create the database, run the following command:
```
rails db:create
```
To migrate the database schema, run the following command:
```
rails db:migrate
```
### Running the App
To run the application, run the following command:
```
rails server
```
This will start the Rails development server and you can access the application by visiting http://localhost:3000 in your web browser.
The collaborators of this project.
👨🚀 **M Nisar Ali**
- GitHub: [@MNisarAli](https://github.com/MNisarAli)
- Gmail: [@[email protected]](mailto:[email protected])
- LinkedIn: [@Muhammad Nisar Ali](https://www.linkedin.com/in/muhammad-nisar-ali)
👨🚀 **Anita Sharma**
- GitHub: [@anita00001](https://github.com/anita00001)
- LinkedIn: [anitaa-sharmaa](https://www.linkedin.com/in/anitaa-sharmaa/)
- Twitter: [@anitaa_sharmaa](https://twitter.com/anitaa_sharmaa)
- [ ] **More conditional checking and features will be added in future**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️, if you like this project!, also follow me on [GitHub](https://github.com/MNisarAli) & [LinkedIn](https://www.linkedin.com/in/muhammad-nisar-ali).
I would like to thank:
- [Microverseinc](https://github.com/microverseinc) for [Readme-template](https://github.com/microverseinc/readme-template).
This project is [MIT](./LICENSE) licensed.