Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stephnna/recipe-app
https://github.com/stephnna/recipe-app
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/stephnna/recipe-app
- Owner: stephnna
- Created: 2022-12-12T07:32:44.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2022-12-17T21:56:15.000Z (about 2 years ago)
- Last Synced: 2024-04-22T06:10:04.367Z (8 months ago)
- Language: Ruby
- Size: 240 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 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.
> The following tech stack was used:
Client
Server
Database
> The Following is how you can use the Blog App
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
> Ruby version : `ruby 3.1.2p20`
run `ruby -v`
> SQLite3 version : `3.40.0`
run `sqlite3 --version`
> npm version : `8.15.0`
run `npm -v`
> yarn version : `1.22.19`
run `yarn -v`
> Database : **PostgreSQL**
### Setup
Clone this repository to your desired folder:
> `git clone [email protected]:David-Kasilia/blog_app_ror.git `
### Install
Install this project with:
> `bundler install`
### Usage
To run the project, execute the following command:
To Be able to run the project:
`rails assets:precompile`
Then To run it on the local host server use:
`rails server` or `rails s`
### Run tests
To run tests, run the following command:
`rspec spec`
### Deployment
You can deploy this project using:
- Heroku: [Recipe App ](https://recipe-website.herokuapp.com/users/sign_up)
> 👤 **David Kasilia Mwanzia**
- GitHub: [@David-Kasilia ](https://github.com/githubhandle)
- Twitter: [@DavidKasilia](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
> 👤 **Haamid Ali**
- GitHub: [@Haadii ](https://github.com/githubhandle)
- Twitter: [@Haamid Ali](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
> 👤 **Stephen Ezea**
- GitHub: [@stephnna ](https://github.com/githubhandle)
- Twitter: [@Stephen Ezea](https://twitter.com/twitterhandle)
- LinkedIn: [LinkedIn](https://linkedin.com/in/linkedinhandle)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project...
> Give credit to everyone who inspired your codebase.
I would like to thank...
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._