Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

A full-stack blog app built with Ruby on Rails framework
https://github.com/peteugwu/blog-app

authorization blog capybara-rspec devise integration postgresql rails-application ruby ruby-gem ruby-on-rails seed

Last synced: 6 days ago
JSON representation

A full-stack blog app built with Ruby on Rails framework

Host: GitHub
URL: https://github.com/peteugwu/blog-app
Owner: PeteUgwu
License: mit
Created: 2023-04-05T22:06:01.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-04-22T20:25:38.000Z (over 1 year ago)
Last Synced: 2024-12-20T22:23:39.294Z (6 days ago)
Topics: authorization, blog, capybara-rspec, devise, integration, postgresql, rails-application, ruby, ruby-gem, ruby-on-rails, seed
Language: Ruby
Homepage:
Size: 208 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 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 

> In this project, we add some API endpoints to your Blog app. This will allow our app to be used in different ways, rather than just through our site - for example, a mobile app or a CLI application.

### Key Features 

- Create an API endpoint to list all posts for a user.

- Create an API endpoint to list all comments for a user's post.

- Create an API endpoint to add a comment to a post. Remember that the owner of the comment is the user that makes it; it should not be set by passing a parameter.

- Our API endpoints should receive JSON and respond JSON as well.

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

```

 git clone https://github.com/PeteUgwu/Blog-App.git

```

### Install

Install this project with:

```

  cd Blog-App

  bundle install

```

```

  Setup database credentials

  config/database.yml

```

### Usage

To run the project, execute the following command:

```

rails server

```

### Run tests

To run tests, run the following command:

```

rspec spec --format documentation

```

(back to top)


## 👥 Author 

👤 Peter Ugwu

- GitHub: [@PeteUgwu](https://github.com/PeteUgwu)

- Twitter: [@Petrus4Charles](https://twitter.com/Petrus4Charles)

- LinkedIn: [@peteugwu](https://www.linkedin.com/in/peteugwu/)

👤 **Bernabas**

- GitHub: [@githubhandle](https://github.com/bernabasy)

- Twitter: [@twitterhandle](https://twitter.com/@bernabasjosef)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/bernabas-yosef)

(back to top)


## 🔭 Future Features 

- [ ] Update style to make more nice.

(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, Please give it a ⭐️

(back to top)


## 🙏 Acknowledgments 

Thanks [@microverse](https://www.microverse.org/)

(back to top)


## FAQ 

# How do I add route to rail app?

- Run rails routes

# How do I generate rails controller files?

- Run rails g controller controller_name

  NB: It is a naming convention to pluralize controller names

## 📝 License 

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

(back to top)