Gdiazdiaz/App-Blog

Our blog app enables user account creation, post sharing, and interactive features. It includes secure authentication, a rich text editor for composing posts, and a comprehensive liking and commenting system.

📗 Table of Contents

• 📖 About the Project
  • Tech Stack
  • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Blog-App

** BlogApp ** Is a Ruby on Rails is project that will allow the user to have an account, post a blog, comment and like.

🛠 Built With

• Ruby

• Ruby on Rails

Key Features

• Back-End Ruby on Rails operations

(back to top)

💻 Getting Started

To get the content of this project locally you need to run the following commands in your terminal:

and follow these steps.

Prerequisites

• IDE(code editor) like: Vscode, Sublime, etc.
• Git

Setup

Clone this repository to your desired folder:

1. Download the Zip file or clone the repo with:

git clone git@github.com:Gdiazdiaz/App-Blog.git

2. To access cloned directory run:

cd curriculum 

Install

To install linters and other project's dependencies run:

 bundle install

Usage

To run the project, execute the following command:

1. setup the database:

rails db:setup

2. run the rails server:

rails s

For the API To get the users on the browser http://127.0.0.1:3000/users To get a specific user http://127.0.0.1:3000/users/:user_id To get the posts for a user http://127.0.0.1:3000/users/:user_id/posts To get a specific post http://127.0.0.1:3000/users/:user_id/posts/:post_id To get the comments of a post http://127.0.0.1:3000/users/:user_id/posts/:post_id/comments To post a comment send a POST request with the format { "author_id": user_id, Note: :user_id must be the id of the user who creates the comment. "text": "your comment" }

Run tests

rspec spec

For tracking linter errors in Ruby files run:

  rubocop . 

(back to top)

👥 Authors

👤 Glenda Diaz

• GitHub: @gjuliao
• LinkedIn: Glenda Diaz

👤 Shahadat Hossain

(back to top)

🔭 Future Features

• [likes-will-be-unique]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse team, all micronauts and my coding-partners for the support.

(back to top)

📝 License

This project is MIT licensed.

(back to top)