Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/naledi-dikgale/blog-app


https://github.com/naledi-dikgale/blog-app

Last synced: 8 days ago
JSON representation

Awesome Lists containing this project

README

        

# Blog-app

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 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)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Blog-app]

**[Blog-app]** is a dynamic and interactive website that showcases a variety of posts. Users can engage with the content by adding comments and liking posts, fostering a vibrant community.

## 🛠 Built With

### Tech Stack

Ruby on Rails

### Key Features

- **[Showcase Posts]**
- **[Add comments]**
- **[Add likes]**

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

- Install Ruby
- Install Rails
- Install Postgresql

### Setup

Clone this repository to your desired folder:

```sh
cd Blog app
git clone https://github.com/Naledi-Dikgale/blog-app.git
```

### Install

Install this project with:

```sh
cd Blog app
bundle install
```
```sh
gem install rspec
```
```sh
gem install --no-document rubocop -v '>= 1.0, < 2.0'
```
```sh
npm install --save-dev [email protected] [email protected] [email protected] [email protected]
```

### Usage

To run the project, execute the following command:

```sh
rails db:create
```
```sh
rails db:migrate
```
```sh
rake db:migrate
```
```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rubocop --color
```
```sh
npx stylelint "**/*.{css,scss}"
```
```sh
rspec
```

(back to top)

## 👥 Authors

👤 **Author1**
*[NALEDI DIKGALE]*

- GitHub: [@githubhandle](https://github.com/Naledi-Dikgale)
- Twitter: [@twitterhandle](https://twitter.com/ChichiTheStar)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/naledi-dikgale-068423159/)
- Website: [@portfolio](https://naledi.netlify.app/)

👤 **Author2**
*[Lugard Agu]*

- GitHub: [@lugard1](https://github.com/lugard1)
- Twitter: [@Dsn3kings](https://twitter.com/Dsn3kings)
- LinkedIn: [@LugardAgu](https://www.linkedin.com/in/lugardagu)

(back to top)

## 🔭 Future Features

- [ ] **[Add delete feature]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Naledi-Dikgale/blog-app/issues).

(back to top)

## ⭐️ Show your support

If you like this project please show support by staring ⭐️.

(back to top)

## 🙏 Acknowledgments

* I would like to give Microverse my sincerest gratitude for accommodating me in the Full-time Software Development program.

(back to top)

## 📝 License

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

(back to top)