Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: about 1 month 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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Obiebi Okiemute David

> Blog app is a website that allows users to create, edit, comment and delete posts, keeping data in a database. This project implements both authorization and authentication in order to provide extended functionality to logged in and authorized users.

## 🛠 Built With

### Tech Stack

> Here is a list of technogies used in this project.

Language

Framework

Database

### Key Features

- **[Fuilly functional Backend]**
- **[Dynamic routing]**

(back to top)

## 🚀 Live Demo

- [Coming soon...]()

(back to top)

## 💻 Getting Started

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

Clone this repository to your desired folder:

```bash
$ git clone https://github.com/DuaneDave/Blog-app.git
$ cd blog_app
```

### Prerequisites

In order to work on this project, you need to have the following dependencies installed:

- [Ruby](https://www.ruby-lang.org/en/)
- [Postgresql](https://www.postgresql.org/)
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://yarnpkg.com/)
- [Rails](https://rubyonrails.org/)

### Install

Install this project with:

```bash
$ bundle install
```

To get all the gems required for the project

Then, run

```bash
$ npm install
```

To install packages such as style linters

To check linters locally, use

```
bash
$ rubocop
$ npx stylelint "**/*.{css,scss}"
```

### Usage

To run the project, execute the following command:

```
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec ./spec/models
rspec ./spec/requests
```

## 👥 Authors

## Author

👤 **Obiebi David**

- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi/)

(back to top)

## 🔭 Future Features

- [ ] **[Add a blog]**
- [ ] **[Delete a blog]**

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

(back to top)

## 🙏 Acknowledgments

I would like to thank all those whose code snippets were used in this project.

- Microverse
- Coding Partners
- Inspiration

(back to top)

## 📝 License

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

(back to top)