https://github.com/ashmalzahra/blog-app

The Blog app is a classic example of a blog website. It is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/ashmalzahra/blog-app

api-endpoints best-practices postgresql request-testing rspec rspec-rails ruby ruby-on-rails

Last synced: 9 days ago
JSON representation

The Blog app is a classic example of a blog website. It is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

• Host: GitHub
• URL: https://github.com/ashmalzahra/blog-app
• Owner: ashmalzahra
• License: mit
• Created: 2023-05-02T17:38:27.000Z (almost 2 years ago)
• Default Branch: develop
• Last Pushed: 2023-05-19T18:09:21.000Z (over 1 year ago)
• Last Synced: 2024-12-18T16:28:48.972Z (about 2 months ago)
• Topics: api-endpoints, best-practices, postgresql, request-testing, rspec, rspec-rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 200 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




   
Blog App



# 📗 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)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ (OPTIONAL)](#faq)

- [📝 License](#license)

# 📖 Blog app 

**Blog app** The Blog app is a classic example of a blog website. It is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
Ruby

    
Ruby on Rails

  


  Server

  


    
N/A

  


Database

  


    
PostgreSQL

  


### Key Features 

- **ROR Framework**

(back to top)


## 💻 Getting Started 

To get a local copy of this project and run it in your computer, follow these steps.

### Prerequisites

In order to run this project you need:

- A working computer.

- Connection to internet.

### Setup

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

Clone this repository in the desired folder:

```

cd my-folder

git clone https://github.com/ashmalzahra/blog-app.git

```

### Install

To install this project:

```

cd blog-app

code .

bundle install

```

### Usage

To run the project, execute the following command:

```

rails server

```

### Run Tests

For rails +7, include the following in your gemfile in the development, test group:

```

group :development, :test do  

  gem 'rspec-rails'

end

```

and 

```

gem 'rails-controller-testing'

```

then run: 

```

bundle install

```

To setup rspec, run the following:

```

rails generate rspec:install

```

To run the project tests, execute the following command:

```

rspec

```

(back to top)


## 👥 Authors 

👤 **Ashmal Zahra**

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

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

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

(back to top)


## 🔭 Future Features 

- [ ] **Add API endpoints.**

- [ ] **API documentation.**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ashmalzahra/blog-app/issues).

(back to top)


## ⭐️ Show your support 

Give a ⭐️ if you like this project!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the information provided to build this project.

(back to top)


## ❓ FAQ (OPTIONAL) 

- **Can I use the project for any purpose?**

  - Yes, you can.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)