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

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

A blog application with Ruby on Rails
https://github.com/libercosoft/blog-app

Last synced: 2 months ago
JSON representation

A blog application with Ruby on Rails

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 RAILS BLOG APP ](#-rails-blog-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Install \& Setup](#install--setup)
- [Tests](#tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [📝 License ](#-license-)

# 📖 RAILS BLOG APP

**Rails Blog App** is a simple blog application created with ruby on rails.

## 🛠 Built With

### Tech Stack

Server

Database

### Key Features

- **Create User, Post, Comment and Likes table for the blog**
- **Save all information in postgres database**
- **Retrive information from the database**

(back to top)

## 💻 Getting Started

> To start and run this project
```
bundle install
```
```
ruby main.rb
```

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

### Prerequisites

- IDE / Editor
- Git
- PostgreSQL

### Install & Setup

To setup and install this sample ROR Blog project, follow the below steps:
- Clone this project by the command:

```
$ git clone https://github.com/LIBERCOSOFT/blog-app.git
```

- Then switch to the project folder by the bellow query:

```
$ cd blog-app
```

- Install the required dependecies with `bundle install`
- Install npm dependencies with `npm install`
- **Before running below commands update [config/database.yml](./config/database.yml) with your local `DB`credentials. Then run:**
- **`rails db:create`**
- **`rails db:migrate`**
- **`rails db:seed`**
- With Ruby on Rails and PostgreSQL installed in your environment, you can run `rails server` to run the website.

### Tests

- Run `rails db:seed RAILS_ENV=test` to seed the testing database
- Run `rspec`

### Deployment

N/A

(back to top)

## 👥 Authors

👤 **Kolapo Precious Akinrinlola**

- GitHub: [LIBERCOSOFT](https://github.com/LIBERCOSOFT)
- Twitter: [@Gerfieldt](https://twitter.com/Gerfieldt)
- LinkedIn: [Kolapo Akinrinlola](https://linkedin.com/in/kolapo-akinrinlola)

👤 **Amine**

- GitHub: [@ouasamine](https://github.com/ouasamine)
- Twitter: [@ouass_amine](https://twitter.com/ouass_amine)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/amine-ouassef)

## 🔭 Future Features
- [ ] **Create a proper view for the project (Frontend)**
- [ ] **Implement API Endpoints**
- [ ] **Implement authentication and authorization**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project do not forget to start the repository.

(back to top)

## 📝 License

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

(back to top)