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

https://github.com/powerlevel9000/blog

Blog is Ruby on Rails based project The Blog app will be a classic example of a blog website fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts. Blog is where you can talk about anything you did
https://github.com/powerlevel9000/blog

postgresql-database ruby ruby-on-rails

Last synced: 11 months ago
JSON representation

Blog is Ruby on Rails based project The Blog app will be a classic example of a blog website fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts. Blog is where you can talk about anything you did

Awesome Lists containing this project

README

          


logo

# ๐Ÿ“— Table of Contents
- [๐Ÿˆธ App Mock](#app-mock)
- [๐Ÿ“– About the Project](#about-project)
- [๐Ÿงช Linters](#linters)
- [๐Ÿ›  Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [๐Ÿ’ป Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [๐Ÿ‘ฅ Authors](#authors)
- [๐Ÿ‘๏ธ Presentation for Project](#video-presentation-for-our-project)
- [๐Ÿ”ญ Future Features](#future-features)
- [๐Ÿค Contributing](#contributing)
- [โญ๏ธ Show your support](#support)
- [๐Ÿ™ Acknowledgements](#acknowledgements)
- [๐Ÿ“ License](#license)

# ๐Ÿˆธ App mock

App Mock under construction...

# ๐Ÿ“– Blog

Blog is `Ruby on Rails` based project
The Blog app will be a classic example of a blog website fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

**Blog** is where you can talk about anything you did

## ๐Ÿงช Linters And test
[![Linters](https://github.com/PowerLevel9000/Blog/actions/workflows/linters.yml/badge.svg)](https://github.com/PowerLevel9000/Blog/actions/workflows/linters.yml)

## ๐Ÿ›  Built With

### Tech Stack

In this project we utilize our skills and knowledge to create this project

Project language

FrameWork

DataBase

### Key Features

- **Create A blog**
- **Account Feature**
- **Dashboard**
- **Database**
- **Authentication And Authorization**
- **like**
- **Comment**
- **log in**
- **Sign in**
- **Api Integration**

(back to top)

## ๐Ÿ’ป Getting Started

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

### Prerequisites

In order to run this project you need:

- Ruby installed in your machine
- Ruby on Rails installed in your machine
- Postgres installed and all password and user being setup
- Any integrated terminal like
- CMD
- Bash
- PowerShell
- etc

### Setup

Clone this repository to your desired folder:

for cloning follow this steps
- go to green `code` button very top left corner of this Repository container
- copy your `SSH` or `https` file and clone it in your desired folder
- or just download `ZIP` file
- [ ] Change UserName and Password with yours in [database.yml](./config/database.yml) file

**OR**

- [ ] Delete the [credentials.yml.enc](./config/credentials.yml.enc)
- run `EDITOR=" --wait" bin/rails credentials:edit"` and add following line in the file and close it. message pop up file save
```
user:
username: "your user name"
password: "your Password"
```
### Install

Install this project with:

for now you don't need any installation to run project if you already followed [Prerequisites](#prerequisites)

and
```
bundle install
npm install
```

### Usage

To run the project, execute the following command:

you can use it for you library purpose
run following commands in you `terminal` in root `dir` and if you open http://localhost:3000/ you can see App running
```
rails s # for running app server on port 3000
rails c # for rails console
```

### Run tests

To run tests, run the following command:

```
rspec spec
```

And for Linters

```
rubocop . //=> for ruby file linting
npx stylelint "**/*.{css,scss}" //=> for CSS or SASS file linting
```
`-A` and `--fix` for auto fixing respectively

(back to top)

## ๐Ÿ‘ฅ Authors

๐Ÿ‘ค **Adarsh Pathak**

- GitHub: [@PowerLevel9000](https://github.com/PowerLevel9000)
- Twitter: [@PowerLevel9002](https://twitter.com/PowerLevel9002)
- LinkedIn: [Adarsh pathak](https://linkedin.com/in/PowerLevel)
- Portfolio: [Adarsh Pathak](https://PowerLevel9000.github.io/portfolio-project/)

๐Ÿ‘ค **Damilare Adepoju**

- GitHub: [@githubhandle](https://github.com/adamilare)
- Twitter: [@twitterhandle](https://twitter.com/mailtodare)
- LinkedIn: [LinkedIn](https://linkedin.com/in/damilareadepoju)
- GitUp Page: [My Page](https://adamilare.github.io/)

(back to top)

# ๐Ÿ‘๏ธ Presentation for Project

[presentation-video](https://youtu.be/OCLadxqMB7U)

(back to top)

## ๐Ÿ”ญ Future Features

- [ ] **Styling of various webpage**
- [ ] **Improved Dashboard**
- [ ] **Notification Feature**
- [ ] **Animation**
- [ ] **Dislike and Edit comments**

(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

[![BuyMeACoffee](https://img.shields.io/badge/Buy%Me%20a%20Coffee-ffdd00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/adi8090808E)

**or**

If you like this project please give it star

(back to top)

## ๐Ÿ™ Acknowledgments

I would like to thank microverse to give this opportunity to show up my skills

and the Ruby on rails docs

(back to top)

## ๐Ÿ“ License

This project is [GPL-3.0](./LICENSE) licensed.

(back to top)