Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

This is a blog app, built using Ruby on Rails
https://github.com/usirusenikon/blog-app

Last synced: 5 days ago
JSON representation

This is a blog app, built using Ruby on Rails

Awesome Lists containing this project

README

        

# 📗 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-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Install \& Setup](#install--setup)
- [Tests](#tests)
- [Deployment](#deployment)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Blog-App

**Blog App** is an example of a blog website built using Ruby on Rails and PostgreSQL.It is a fully functional website that shows a list of posts, users can also interact with posts, likes and comments.

## 🛠 Built With

### Tech Stack

Client

Database

### Key Features
- Making use of Ruby on Rails
- Making use of PostgreSQL

(back to top)

## 🚀 Live Demo

> None

(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 to edit and run the code (We use Visual Studio Code 🔥).
- Git to versionning your work.
- 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/UsirusenIkon/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:**
- **`rake db:create`**
- **`rake db:migrate`**
- **`rake db:seed`**
- With Ruby on Rails and PostgreSQL installed in your environment, you can run `rails server` to run the website.

### Tests

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

### Deployment

N/A

(back to top)

## 👥 Author

👤 **Usirusen Ikon**

👤 **Usirusen Ikon**
- GitHub: [@UsirusenIkon](https://github.com/UsirusenIkon)
- Twitter: [@Usirusen_Ikon](https://twitter.com/Usirusen_Ikon)
- LinkedIn: [Usirusen Ikon](https://www.linkedin.com/in/usirusen-ikon-775855174/)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **Build the project schemas**
- [ ] **Use postgresql as my database instead of sql**

(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 give it a :star

(back to top)

## 🙏 Acknowledgments

- I would like to thank Microverse.
- Hat tip to anyone whose code was used
- Inspiration
- etc

(back to top)

## 📝 License

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

(back to top)