Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

The Blog app is a classic example of a blog website. It is a fully functional website that shows a list of posts and empowers readers to interact with them by adding comments and liking posts.
https://github.com/nahnahaj/blog-app

bootstrap css3 database html5 javascript rails ruby rubyonrails

Last synced: 27 days ago
JSON representation

The Blog app is a classic example of a blog website. It is a fully functional website that shows a list of posts and empowers readers to interact with them by adding comments and liking posts.

Awesome Lists containing this project

README

        


logo

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Blog-App

**The Blog App** is a classic example of a blog website built using Ruby on Rails and PostgreSQL.It is a fully functional website that shows a list of posts and empowers readers to interact with them by adding comments and liking posts.

## 🛠 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/NahnahAJ/Blog-App.git
```

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

```
$ cd blograils
```

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

## 👥 Authors

👤 **Nahnah Ahjuwah**

- GitHub: [@NahnahAJ](https://github.com/NahnahAJ)
- Twitter: [@NahnahAhjuwah](https://https://twitter.com/NahnahAhjuwah)
- LinkedIn: [Felicia-Awuah](https://www.linkedin.com/in/felicia-awuah-gyedua/)

👤 **Is-haq, Adnan Olamilekan**
- GitHub: [@AdnanOlarmmi](https://github.com/adnanolarmmi)
- Twitter: [@AdnanIshaqOla](https://twitter.com/AdnanIshaqOla)
- LinkedIn: [Adnan (Olamilekan) Is-haq](https://linkedin.com/in/adnan-is-haq-olamilekan)

(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 ⭐️

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