Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mesi21/yelp_demo

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/mesi21/yelp_demo
Owner: Mesi21
License: mit
Created: 2023-08-24T09:11:08.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2023-09-03T14:17:05.000Z (over 1 year ago)
Last Synced: 2025-01-16T00:19:49.343Z (27 days ago)
Language: Ruby
Size: 1.88 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: license.txt

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Yelp Demo App - with Rails 

** Yelp Demo App is a classic example of a blog. It shows the list of posts and empower readers to interact with them by adding comments and liking posts

## 🛠 Built With 

### Tech Stack 

  Client

  


    Ruby

  


  Server

  


    Ruby on Rails

  


Database

  


    PostgreSQL

  


### Key Features 

- Classic Blog App

- Users can make new posts

- Users can make comments on the posts

- Users can add likes to posts or comments

(back to top)


## 💻 Getting Started 

To get a local copy up and running, follow these steps.

### Prerequisites

In order to run this project you need:

Before you install Rails, make sure that your system has the proper prerequisites installed. These include:

- Ruby installed and running.

- PostgreSQL installed and running.

Afterwards run this in your terminal:

```

 gem install rails

```

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:Mesi21/yelp_demo.git

```

### Install

Install this project with:

```sh

  cd yelp_demo

  bundle install

```

### Usage

To run the project, execute the following command:

```sh

  rails server

  or

  rails s

  and open localhost

  http://127.0.0.1:3000/

```

### Run tests

To run tests, run the following command:

- MiniTest:

```sh

  rails test

```

- RSpec:

```sh

  rspec spec

```

## 👥 Author

👤 **Molnar Emese**

  - GitHub: [@Mesi21](https://github.com/Mesi21)

  - Twitter: [@buksimesi21](https://twitter.com/buksimesi21)  

  - LinkedIn: [LinkedIn] (https://www.linkedin.com/in/emesemesimolnar/)

(back to top)


## 🔭 Future Features 

- DB optimization

- Update the UI

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page]https://github.com/Mesi21/yelp_demo/issues

(back to top)


## ⭐️ Show your support 

If you like this project, please give it a :star: 

(back to top)


## 🙏 Acknowledgments 

I would like to thank everyone who reviewed this project.

(back to top)


## 📝 License 

This project is [MIT](license.txt) licensed.

(back to top)