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

https://github.com/indiecodermm/blogify

A blogging platform with user authentication, authorization and like/comment features. Built with Ruby on Rails + PostgreSQL
https://github.com/indiecodermm/blogify

Last synced: 5 months ago
JSON representation

A blogging platform with user authentication, authorization and like/comment features. Built with Ruby on Rails + PostgreSQL

Awesome Lists containing this project

README

          


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

Table of Contents

- [๐Ÿ“ฐ Blogify - Rails App ](#-blogify---rails-app-)
- [๐Ÿงฐ Tech Stack ](#-tech-stack--)
- [โœจ Key Features ](#-key-features--)
- [๐Ÿ“˜ 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-)

# ๐Ÿ“ฐ Blogify - Rails App

**Blogify** is a simple, easy-to-use blogging platform which allows users to create and publish their own blog posts. Users can also read posts from other users and give likes/comments.

(back to top)

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

(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)

## ๐Ÿ“˜ 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.1.3 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 foler.

```sh
cd my-project
git clone git@github.com:IndieCoderMM/blogify.git .
```

### ๐Ÿ“ฅ 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

๐Ÿ‘ค **Hein Thant**

- GitHub: [@IndieCoderMM](https://github.com/indiecodermm)
- LinkedIn: [@hthantoo](https://linkedin.com/in/hthantoo)
- Gmail: hthant00chk@gmail.com

๐Ÿ‘ค **Thomas Obuya**

- GitHub: [@githubhandle](https://github.com/tobuya)
- Twitter: [@twitterhandle](https://twitter.com/MullerTheGreat1)
- LinkedIn: [LinkedIn](https://linkedin.com/in/tobuya)

(back to top)

## ๐ŸŽฏ Future Features

- [ ] Add tests
- [ ] Create API endpoints
- [ ] Implement authentication
- [ ] Improve UI

(back to top)

## ๐Ÿค Contribution

Contributions, issues, and feature requests are welcome!

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

(back to top)

## ๐Ÿ’– Show Your Support

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

(back to top)

## ๐Ÿ™ Acknowledgements

I would like to thank all code reviewers for making this project better.

(back to top)

## ๐Ÿ“œ License

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

(back to top)