Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Last synced: 8 days ago
JSON representation

Host: GitHub
URL: https://github.com/danielsafari143/blog-app
Owner: danielsafari143
License: mit
Created: 2023-08-15T09:56:30.000Z (over 1 year ago)
Default Branch: develop
Last Pushed: 2023-09-02T09:28:20.000Z (about 1 year ago)
Last Synced: 2024-04-23T02:51:54.662Z (7 months ago)
Language: Ruby
Size: 149 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



  Blog-app



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Blog-app](#-catalog-of-things)

  - [🛠 Built With ](#-built-with-)

    - [Tech Stack ](#tech-stack-)

    - [Key Features ](#key-features-)

  - [💻 Getting Started ](#-getting-started-)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Usage](#usage)

    - [Run tests](#run-tests)

  - [👥 Authors ](#-authors-)

  - [🔭 Future Features ](#-future-features-)

  - [🤝 Contributing ](#-contributing-)

  - [⭐️ Show your support ](#️-show-your-support-)

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [📝 License ](#-license-)

# 📖 Blog-app

This is a simple, fully-functional, secure, scalable, and user-friendly blog app built with Ruby on Rails that allows users to create, read, edit, and delete posts. It also allows users to comment on posts and like posts.

## 🛠 Built With 

### Tech Stack 

- RUBY

### Key Features 

- [ ] **Users can create, read, edit, and delete posts.**

- [ ] **Users can comment on posts.**

- [ ] **Users can like posts**

- [ ] **Test for all models**

(back to top)


## 💻 Getting Started 

To get started with this app, you will need to have Ruby and Rails installed on your computer. Once you have Ruby and Rails installed.

## API Documentations

```sh

  http://localhost:3000/api-docs/index.html

```

## API endpoints

```sh

  Get  : http://localhost:3000/users/:user_id/posts.json

  Get  : http://localhost:3000/users/:user_id/posts/:post_id/comments.json

  Post : http://localhost:3000/users/:user_id/posts/:post_id/comments

```

### Prerequisites

In order to run this project you need:

- git

- Ruby

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/danielsafari143/blog-app.git

  bundle install

```

### Usage

To run the project, execute the following command:

```sh

  rails db:create

  rails db:migrate

  rails server

```

### Run tests

To run tests, run the following commands:

```sh

  rspec

  rubocop

```

(back to top)


## 👥 Authors 

👤 **Safari Hamuli**

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

- LinkedIn: [Safari Daniel](https://www.linkedin.com/in/safari-daniel/)

(back to top)


## 🔭 Future Features 

- [] **Authentification, Authorization**

(back to top)


## 🤝 Contributing 

If you would like to contribute to this app, please feel free to fork the repository and submit a pull request.

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

(back to top)


## ⭐️ Show your support 

If you like this project give me a follow and/or a star

(back to top)


## 🙏 Acknowledgments 

We would like to thank all my coding partners at Microverse

(back to top)


## 📝 License 

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

(back to top)