Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghostesso/ror-recipe-app
https://github.com/ghostesso/ror-recipe-app
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ghostesso/ror-recipe-app
- Owner: GhostEsso
- License: mit
- Created: 2023-11-13T10:00:19.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-11-18T11:12:55.000Z (about 1 year ago)
- Last Synced: 2024-10-17T06:16:34.358Z (about 1 month ago)
- Language: Ruby
- Size: 53.1 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe App
# 📗 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)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ (OPTIONAL) ](#-faq-optional-)
- [📝 License ](#-license-)
The **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 should allow you to make them public so anyone can access them.
Client
Server
Database
- **read public recipes and their ingredients**
- **authentication and authorization**
- **add/delete foods**
- **add/delete recipes**
- **add/edit/delete ingredients**
- **make a recipe private/public**
- **generate shopping list**
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- GitHub account;
- Git installed on your OS;
- VSCode (or another code editor);
- modern browser (supporting HTML5 and CSS3) is highly recommended;
- [Ruby](https://www.ruby-lang.org/en/documentation/installation/) installed;
- [Ruby on Rails](https://gorails.com/guides) installed;
- [Node.js and npm](https://nodejs.org/) installed.
### Setup
Clone this repository to your desired folder:
Login to your GitHub account. Clone this repository to your desired folder:
> cd my-folder
> git clone [email protected]:GhostEsso/ror-recipe-app.git
Setup database:
> sudo -u postgres createuser --interactive --pwprompt
(provide the username and password described in [config/database.yml](./config/database.yml))
### Install
Install the dependencies:
> gem install
> npm install
Create database:
> bin/rails db:create
(OPTIONAL) Fill the database with sample records:
> bin/rails db:seed
### Usage
To run the server:
> rails server
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
### Run tests
To run tests, run the following command:
> rspec
You can also check linter errors by running these commands:
> rubocop
(OPTIONAL) For testing the confirmation emails:
> gem install mailcatcher
Open [http://localhost:1080](http://localhost:1080) to view it in your browser.
👤 **Essohanam TAMBANA**
- GitHub: [@GhostEsso](https://github.com/GhostEsso)
- Twitter: [@TambanaEssohana](https://twitter.com/TambanaEssohana)
- LinkedIn: [Tambana Essohanam](https://www.linkedin.com/in/essohanam-tambana-62aa081a1/)
👤 **Javier Hernandez**
- GitHub: [@wickathou](https://github.com/wickathou)
- LinkedIn: [@javierjhm](https://www.linkedin.com/in/javierjhm/)
- Portfolio: [@End Design Co.](https://enddesign.co/)
- [ ] **add inventories list (with all CRUD implementation)**
- [ ] **add food list for a given inventory (with all CRUD implementation)**
- [ ] **add inventory shopping list, a shopping list, but only taking into consideration a chosen recipe and inventory**
- [ ] **improve UX/UI design**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project just star it!
We would like to thank the Microverse program for the knowledge and skills we have acquired in Modules 1-5.
We are grateful to all previous project reviewers for their advice. Thanks to them we could build this app.
- **Why is there no Live Demo link?**
- This is a student project and the Live Demo will be added after reaching the corresponding phase of the project.
This project is [MIT](./LICENSE) licensed.