Skip to content

Commit

Permalink
update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
anas599 committed Jun 27, 2023
1 parent 77c6628 commit b22baa2
Showing 1 changed file with 15 additions and 16 deletions.
31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h2>Recipe-App</h2>
<img src="app/assets/images/cook-book.png" alt="Icon" width="100px" height="100px" />
<br>
<br>

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
Expand All @@ -24,11 +24,15 @@
- [📝 License](#license)

# 📖 Recipe-App <a name="about-project"></a>

Recipe App is a robust and user-friendly recipe application built using Ruby on Rails, leveraging the power of Bootstrap, Devise, and Capybara gems. Seamlessly create, discover, and share recipes with it. It offers a delightful cooking experience with its intuitive interface and extensive features.
**Recipe-App**
**Recipe-App**

## 🛠 Built With <a name="built-with"></a>

PostgresSQL
Ruby on rails

### Tech Stack <a name="tech-stack"></a>

<details>
Expand All @@ -41,6 +45,7 @@ Ruby on rails
<br>

### Key Features <a name="key-features"></a>

<details>
<ul>
<li>Add Foods with its value and measure unit</li>
Expand All @@ -58,9 +63,11 @@ Ruby on rails
- [Click Here](https://mysite-uoec.onrender.com/)

## 💻 Getting Started <a name="getting-started"></a>

<br>

### Prerequisites

<details>
<p>In order to run this project you need:</p>
<ul>
Expand All @@ -71,21 +78,18 @@ Ruby on rails
</details>
<br>


### Setup

Clone this repository to your desired folder:

git clone https://github.com/anas599/Recipe-app.git
cd Recipe-App

cd Recipe-App

<br>


### Install


<details>
<p>Install this project with:</p>
<ul>
Expand All @@ -95,8 +99,8 @@ Clone this repository to your desired folder:
</details>
<br>


### Usage

<details>
<p>To run the project, execute the following command:</p>
<ul>
Expand All @@ -106,9 +110,8 @@ Clone this repository to your desired folder:
</details>
<br>



### Run tests

<details>
<p>To run tests, run the following command:</p>
<ul>
Expand All @@ -117,8 +120,8 @@ Clone this repository to your desired folder:
</details>
<br>


### Deployment

<details>
<p>You can deploy this project using:</p>
<ul>
Expand All @@ -141,11 +144,10 @@ Clone this repository to your desired folder:
- Twitter: [@UthmanDeRoyale](https://twitter.com/UthmanDeRoyale)
- LinkedIn: [Uthman Igein Bello-Imoukhuede](https://www.linkedin.com/in/uthmanbelloimoukhuede)


<p align="right">(<a href="#readme-top">back to top</a>)</p>


## 🔭 Future Features <a name="future-features"></a>

<details>
<ul>
<li>Add videos for new data</li>
Expand All @@ -155,17 +157,14 @@ Clone this repository to your desired folder:
</details>
<br>


<p align="right">(<a href="#readme-top">back to top</a>)</p>


## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/anas599/Recipe-app.git/issues/).


<p align="right">(<a href="#readme-top">back to top</a>)</p>

## ⭐️ Show your support <a name="support"></a>
Expand Down

0 comments on commit b22baa2

Please sign in to comment.