https://github.com/lordksix/recipe-app
this is a ruby on rails app
https://github.com/lordksix/recipe-app
Last synced: about 2 months ago
JSON representation
this is a ruby on rails app
- Host: GitHub
- URL: https://github.com/lordksix/recipe-app
- Owner: lordksix
- License: mit
- Created: 2023-09-04T08:05:50.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-09-15T03:51:59.000Z (over 1 year ago)
- Last Synced: 2024-05-17T15:48:28.389Z (about 1 year ago)
- Language: Ruby
- Size: 220 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe App by Rails
# 📗 Table of Contents
- [📗 Table of Contents](#table-of-contents)
- [📖 Recipe by Rails ](#about-project)
- [🛠 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 ](#️support)
- [🙏 Acknowledgments ](#acknowledgements)
- [❓ FAQ ](#faq)
- [📝 License ](#license)
**Recipe by Rails** is a Ruby on Rails web application with PostgreSQL as database. It allows to create recipes, private or public, and generate a shopping list from the ingredients.
Client
Server
Database
- **Gitflow**
- **Linters implemented**
- **Rubocop implemented**
- **Implement Model Migrations**
- **Implement Implement TailwindCSS**
- **Implement unit and integrations tests**
- **Implement authentication and authorization**
- **Use PostgreSQL**
### Prerequisites
In order to run this project you need:
- To clone or fork this repo
- Ruby installed in your machine
- Ruby on Rails gem installed
- PostgreSQL install in you computer
- To modify this profile you will also need a text editor
For more information on how to install ruby on your machine:
- How to install ruby
### Setup
Clone this repository to your desired folder:
For example, using Ubuntu:
```sh
cd my-desired-folder
git clone https://github.com/lordksix/recipe-app.git
```
For more information on how to clone or fork a repository:
- How to clone a repo
- How to fork a repo
### Install
To install dependencies, the following command must be run in the terminal:
```sh
cd recipe-app
bundle install
```
To create database, migrate schema and implement initial database entries
```sh
rails db:drop db:setup
```
### Usage
In the project directory, run the first time:
```sh
bundle exec rake assets:precompile
```
then, you can use:
```sh
./bin/dev
```
or:
```sh
rails s
```
Check on db/seed.rb for pre-loaded users, posts, comments, and likes for development
### Run tests
In the project directory, run the first time:
```sh
bundle exec rake assets:precompile
```
then, you can:
```sh
rspec .
```
however, if you haven't run `./bin/dev`
👤 **lordksix**
- GitHub: [@lordksix](https://github.com/lordksix)
- LinkedIn: [@wladpasquel](https://www.linkedin.com/in/wladpasquel/)
- Medium: [@wladimir.pasquel](https://medium.com/@wladimir.pasquel)
👤 **Tumaini Maganiko**
- GitHub: [@githubhandle](https://github.com/tumainimaganiko)
- Twitter: [@twitterhandle](https://twitter.com/Chief2maini)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tumainimaganiko/)
Future changes:
- Adding Inventories
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project, I encourage you to clone, fork and contribute. Our community and knowledge grows with each engagement.
We would like to thank Microverse for the idea for this project.
- **Do I need a IDE or a special text editor to make changes?**
- No, you don't. You can use NotePad to make changes.
This project is [MIT](./LICENSE) licensed.