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

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

This is a fullstack blog app built with ruby and rails.
https://github.com/tracymuso/blog-app

api css fullstack html ruby ruby-on-rails

Last synced: 4 months ago
JSON representation

This is a fullstack blog app built with ruby and rails.

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)
- [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)
- [❓ FAQ](#faq)
- [📝 License](#license)

# 📖 [Blog App]

>>This is a fullstack blog application. A user can create an account to log in and post articles. In addition, each user is granted the chance to interact with other users posts by adding comments and liking posts. It uses crud methods to create, read, edit and delete posts.

### Tech Stack

Client


  • HTML, CSS

  • JavaScript

Server


  • Ruby on Rails

Database

## Steps of creating the application:

- [x] 1: Creating a data model.
- [ ] 2: Validations and Model specs.
- [ ] 3: Processing data in models.
- [ ] 4: Setup and controllers.
- [ ] 5: Controllers specs.
- [ ] 6: Views.
- [ ] 7: Forms.
- [ ] 8: Integration specs for Views and fixing n+1 problems.
- [ ] 9: Add Devise.
- [ ] 10: Add authorization rules.
- [ ] 11: Add API endpoints.

## Key features :

- Create an account
- All users and their posts can be displayed
- Create a post
- Edit a post
- Delete a post

## ERD diagram
![blog_app_erd](https://user-images.githubusercontent.com/79658534/196410864-c9e7bf4f-1bc1-4aa2-8d46-764b4447bfe9.png)

## Deployment

[Video] Coming soon
[Live demo] Coming soon

## 🛠 Built With

(back to top)

## 💻 Getting Started

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need the following:
- git
- Ruby
- rails
- psql

### Setup

Clone this repository:

```sh
git clone https://github.com/TracyMuso/Blog-App.git
```
Go to your project

```sh
cd my-folder
```

### Install

*Important! You need to have rspec installed in your computer*

Install this projects dependencies with:

```sh
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server or rails s
```

### Run tests

To run tests, run the following command:

```sh
rspec spec spec/file_spec.rb
```

## 👥 Authors

👤 **Tracy Musongole**

- GitHub: [@TracyMuso](https://github.com/TracyMuso)
- LinkedIn: [Tracy Musongole](https://www.linkedin.com/in/tracy-muso/)

👤 **Danny Baraka**

- GitHub: [@DannyBaraka](https://github.com/barakadanny)
- LinkedIn: [Baraka Danny](https://www.linkedin.com/in/danny-baraka-589156169/)

## Future Features

- **Account creation**
- Users will be able to create accounts to log in or out

- **Post creation and interaction**
- Users will be able to create, read, edit and delete posts
- Users will also be able to like and comment on each others posts

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](github.com/TracyMuso/Blog-App/issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank...

- Thanks to [Microverse](https://www.microverse.org/) for giving this opportunity to learn ...
- Code Reviewers & Coding Partners.
- Hat tip to anyone whose code was used.
- Inspiration.

(back to top)

## 📝 License

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)