zunairkhan811 / blog-app

Blog app is a project that allow user to new users, posts, and adding likes and comments in rails framework. Blog API is also created alongwith API docs.

**Blog App**

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Blog API
  • API Docs
  • 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Blog App]

[Blog App] is based on Ruby Language and Rails framework.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Localhost

PostGre SQL

• N/A

Key Features

• [App for blog, create post, add likes and comments]
• [Blog API is also created. API links are accessible at https://localhost:3000/api-docs/index.html after running server by running rails s command in terminal]

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby and Ruby on Rails

Setup

Clone this repository to your desired folder:

cd blog-app
git clone https://github.com/zunairkhan811/blog-app.git

Install

Install this project with:

bundle install

Usage

To run the project, execute the following command:

rail s

Run tests

Run:

rspec spec

Blog API

Blog API is also created:

User can list all user posts through the below link

http://localhost:3000/api/v1/users/:user_id/user_posts

User can see the list of all comments for a posts through the below link

http://localhost:3000/api/v1/posts/:post_id/post_comments

User can create a comment to a post with the following Url link:

http://localhost:3000/api/v1/posts/:post_id/post_comments

API Docs:

API docs are created and are accessible by following steps:

Run below command in the terminal

rails s

Paste this Link below in the Browser

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

(back to top)

👥 Author

👤 Muhammad Zunair khan

• GitHub: @zunairkhan811
• Twitter: @zunairkhan811
• LinkedIn: @mzunairkhan

(back to top)

🔭 Future Features

• [Will add more features in the app]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the repo

(back to top)

⭐️ Show your support

If you like my project kindly comment or Follow me on LinkedIn, Twitter & twitter and always Your feedback will be really appreciated. Thanks!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse and my Code Reviewers.

(back to top)

❓ FAQ (OPTIONAL)

• [What is Blog App?]

  • [In this project, we will creating users, posts, and adding likes and comments in rails framework. Blog API is also created alongwith API docs.]

(back to top)

📝 License

This project is MIT licensed.

(back to top)

blog-app's Issues

Create User Model

Create a user model with its attributes name and email and validation should be done on email. Also set associations for User model.