Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Blog App is a simple blog website where users can create posts, add comments to posts and like posts. This project is built using Ruby on Rails.
https://github.com/mohamedhnoor/blog-app

postgresql rspec-rails ruby ruby-on-rails

Last synced: about 4 hours ago
JSON representation

Blog App is a simple blog website where users can create posts, add comments to posts and like posts. This project is built using Ruby on Rails.

Awesome Lists containing this project

README

        


Blog App


# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [Blog App ](#blog-app-)
- [🛠 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 ](#️-show-your-support-)
- [Acknowledgments](#acknowledgments)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# Blog App

**Blog App** is a simple blog website where users can create posts, add comments to posts and like posts. This project is built using Ruby on Rails.

## 🛠 Built With

### Tech Stack

Server

back to top

## Key Features

> Key Features of Project.

- Users can create posts.
- Users can add comments to posts.
- Users can like posts.

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- Ruby
- Rails
- Postgresql

### Setup

Clone this repository to your desired folder:

```sh
cd your_desired_folder
git clone https://github.com/MohamedHNoor/blog-app.git
```

### Install

Install this project with:

- After cloning type `cd blog-app`.
- Run `bundle install` to install all the required dependencies.

### Usage

To run the project, execute the following command:

- Run `rails db:create` to create a new database
- Run `rails db:migrate` to migrate the db and build the schema
- Run `rails s` to start the server

### Run tests

- Run `bundle exec rspec` to run the tests

back to top

## 👥 Authors

👤 **Mohamed Hassan Noor**

- GitHub: [@MohamedHNoor](https://github.com/MohamedHNoor)
- Twitter: [@MohamedHNoor](https://twitter.com/MohamedHNoor)
- LinkedIn: [@MohamedHNoor](https://www.linkedin.com/in/mohamedhnoor/)

👤 **Christian Ani**

- GitHub: [@iamchristianani](https://github.com/iamchristianani)
- Twitter: [@kriznode](https://twitter.com/kriznode)
- LinkedIn: [Christian Ani](https://www.linkedin.com/in/anikriz/)

back to top

## 🔭 Future Features

- [ ] **[ Create Post ]**
- [ ] **[ Add Comment to a post ]**
- [ ] **[ Like a Post ]**

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

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

back to top

## ⭐️ Show your support

Give a ⭐️ if you like this project!

back to top

## Acknowledgments

- Hat tip to anyone whose code was used
- Inspiration
- etc

## ❓ FAQ

- Do I have to have any previous knowledge about ruby to use this project?

- No!

- How to use this project?
- check the [Getting Started](#getting-started) section to have a complete guid on how to setup and run teh project.

back to top

## 📝 License

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

back to top