https://github.com/ridwanullahi-code/recipeapp
https://github.com/ridwanullahi-code/recipeapp
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/ridwanullahi-code/recipeapp
- Owner: Ridwanullahi-code
- License: mit
- Created: 2023-07-02T19:33:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T11:48:52.000Z (almost 3 years ago)
- Last Synced: 2025-01-30T06:29:29.342Z (over 1 year ago)
- Language: Ruby
- Size: 9.25 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe-app
# :green_book: Table of Contents
- [:green_book: Table of Contents](#-table-of-contents)
- [:book: Recipe App](#Recipe-app)
- [:hammer_and_wrench: Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [:link: Project Link ](#-project-link-)
- [:computer: Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [:busts_in_silhouette: Authors ](#-authors-)
- [:telescope: Future Features ](#-future-features-)
- [:handshake: Contributing ](#-contributing-)
- [:star:️ Show your support ](#️-show-your-support-)
- [:pray: Acknowledgments ](#-acknowledgments-)
- [:memo: License ](#-license-)
# :book: Recipe-app
> 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
## :hammer_and_wrench: Built With
### Tech Stack
Client
- Ruby on Rails
Server
- Ruby on Rails
Database
- Postgresql
### Key Features
- We can add, remove, update and display recipe.
- It has user authentication.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```
- Laptop/Desktop.
- Internet.
- Ruby.
- Rails.
- Vs Code.
```
### Setup
Clone this repository to your desired folder:
```
- mkdir my-folder
- cd my-folder
- https://github.com/Ridwanullahi-code/RecipeApp.git
- cd Recipe-app
- bundle install
- rails db:create
- rails db:migrate
```
### Usage
To run the project, execute the following command:
- rails server
### Run tests
- rspec.
### Check Linter
- rubocop
- npx stylelint "**/*.{css,scss}"
### Deployment
- Netlify
👤 **Walid Kabboussa**
- GitHub: [@Hisoka37](https://github.com/Hisoka37)
- Twitter: [@KBwalid9](https://twitter.com/KBwalid9)
- LinkedIn: [Walid Kabboussa](https://www.linkedin.com/in/walidkb/)
👤 **Ajayi Ridwan**
- Github: [Ridwan](https://github.com/Ridwanullahi-code)
- LinkedIn: [Ridwan](https://www.linkedin.com/in/ajayi-ridwan/)
## :telescope: Future Features
- **Enhance design.**
- **Connect to the Database.**
- **Add API endpoits.**
- **Create Responsive Interface.**
- **Add more animations and transitions.**
## :handshake: Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Ridwanullahi-code/RecipeApp/issues).
## :star:️ Show your support
If you like this project you can fork it.
## :pray: Acknowledgments
I would like to thank... Microvers for giving me this opportunity to build this project
This project is [MIT](./LICENSE) licensed.