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

https://github.com/tobuya/post_stream

The Post Stream 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 by Ruby on Rails
https://github.com/tobuya/post_stream

css3 javascript postgresql ruby ruby-on-rails

Last synced: about 1 year ago
JSON representation

The Post Stream 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 by Ruby on Rails

Awesome Lists containing this project

README

          


[![Contributors](https://img.shields.io/github/contributors/tobuya/post_stream)](https://github.com/tobuya/post_stream/graphs/contributors)
[![LastUpdate](https://img.shields.io/github/last-commit/tobuya/post_stream)](https://github.com/tobuya/post_stream/commits/main)
[![Stargazers](https://img.shields.io/github/stars/tobuya/post_stream)](https://github.com/tobuya/post_streamy/stargazers)
[![Issues](https://img.shields.io/github/issues/tobuya/post_stream)](https://github.com/tobuya/post_stream/issues)
[![License](https://img.shields.io/github/license/tobuya/post_stream)](https://github.com/tobuya/post_stream/blob/main/LICENSE)

Table of Contents

- [๐Ÿ“ฐ Post Stream ](#-post_stream---rails-app-)
- [๐Ÿงฐ Tech Stack ](#-tech-stack--)
- [โœจ Key Features ](#-key-features--)
- [๐Ÿš€ Live Demo](#-live-demo--)
- [๐Ÿ“˜ Getting Started ](#-getting-started--)
- [๐Ÿ“‹ Prerequisites](#-prerequisites)
- [๐Ÿ“‚ Setup](#-setup)
- [๐Ÿ“ฅ Installation](#-installation)
- [๐Ÿ’พ Database](#-database)
- [๐Ÿ’ป Usage](#-usage)
- [๐Ÿงช Run tests](#-run-tests)
- [๐Ÿ‘จโ€๐Ÿš€ Authors ](#-authors--)
- [๐ŸŽฏ Future Features ](#-future-features--)
- [๐Ÿค Contribution ](#-contribution--)
- [๐Ÿ’– Show Your Support ](#-show-your-support--)
- [๐Ÿ™ Acknowledgements](#-acknowledgements)
- [๐Ÿ“œ License ](#-license-)

# ๐Ÿ“ฐ Post Stream

**Post Stream** 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.

(back to top)

## ๐Ÿงฐ Tech Stack
- Ruby on Rails
- PostgreSQL
- Devise
- CanCanCan
- RSpec

(back to top)

## โœจ Key Features
- Create and manage blog posts
- Read posts by other users
- Interact by giving likes/comments
- User authentication and authorization

(back to top)

## ๐Ÿš€ Live Demo

[To be Updated soon]

## ๐Ÿ“˜ Getting Started

To run this project locally, you'll need to follow these steps.

### ๐Ÿ“‹ Prerequisites

Make sure you have the following installed on your machine:
- [Ruby 3.2.2 or higher](https://www.ruby-lang.org/en/)
- [Rails 7.0.4 or higher](https://rubyonrails.org/)
- [PostgreSQL 15.2 or higher](https://www.postgresql.org/)

### ๐Ÿ“‚ Setup

Clone this repository to your desired folder.

```sh
cd my-desired-folder
git clone git@github.com:tobuya/post_stream.git
cd post_stream
```

### ๐Ÿ“ฅ Installation

Install the required gems with:

```sh
bundle install
```

### ๐Ÿ’พ Database

Create the databases and run migrations with:

```sh
rails db:create
rails db:migrate
```

To load the sample data, run:

```sh
rails db:seed
```

### ๐Ÿ’ป Usage

To run the development server, execute the following command:

```sh
rails server
```

### ๐Ÿงช Run tests

To run tests, run the following command:

```sh
rspec spec --format doc
```

(back to top)

## ๐Ÿ‘จโ€๐Ÿš€ Authors

๐Ÿ‘ค **Thomas Obuya**

- [GitHub](https://github.com/tobuya)
- [Medium](https://medium.com/@tobuya)
- [LinkedIn](https://linkedin.com/in/tobuya)

๐Ÿ‘ค **Hein Thant**

- [GitHub](https://github.com/indiecodermm)
- [Medium](https://hthant.medium.com/)
- [LinkedIn](https://linkedin.com/in/hthantoo)

(back to top)

## ๐ŸŽฏ Future Features

- [ ] Search and filter users and posts
- [ ] Implement sharing of posts by other users

(back to top)

## ๐Ÿค Contribution

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/tobuya/post_stream/issues).

(back to top)

## ๐Ÿ’– Show Your Support

If you like this project, please consider giving it a โญ.

(back to top)

## ๐Ÿ™ Acknowledgements

I want to thank all code reviewers for making this project better.
I also want to acknowledge the [Random User Generator](https://randomuser.me), a free and open source API for generating random user profile pictures data for this project.

(back to top)

## ๐Ÿ“œ License

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

(back to top)