sadaf-Daneshgar / blogapp

The Blog app will be a classic example of a blog website. You will create a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

📗 Table of Contents

• 📗 Table of Contents
• 📖 Rail Blog App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Run the seeder
    • Run the App
    • Run Test
    • API Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
    • Contributions, issues, and feature requests are welcome!
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Rail Blog App

Rail-blog-app: Is a blog app built with Ruby on Rails. It allows users to create articles and comment on them. It also allows users to sign up and sign in to the app.

🛠 Built With

Tech Stack

Ruby on Rails

• Ruby
• Ruby

(back to top)

Key Features

• Ruby on Rails
• Creating a data model
• Functional website
• Unit testing
• Database
• Authentication

(back to top)

💻 Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

• Git
• Ruby
• Rails

Setup

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

git clone https://github.com/sadaf-Daneshgar/blogapp.git

2. To access the project directory

cd rail-blog-app

Install

bundle install
rails db:migrate

Run the seeder

rails db:seed

Run the App

rails s

Check http://localhost:3000/ in your browser

Run Test

• To run models tests

rails db:migrate RAILS_ENV=test
rspec

API Usage

• To use the API version make sure to set the header Accept to application/json and the header Content-Type to application/json for all requests.

refer to this discussion for more details API

• To create a comment send a POST request to /users/:user_id/posts/:post_id/comments with http authorization header set to YOUR_API_TOKEN which you can get from your profile page. The body of the request should be a JSON object in the following format:

{
  "text": "comment content"
}

(back to top)

👥 Authors

👤 Sadaf Daneshgar

• 👤 GitHub: @Sadaf-Daneshgar
• 👤 Twitter: @SadafDaneshgar
• 👤 LinkedIn: Sadaf Daneshgar

👤 Second Authors

👤 Mohamed Sabry

• GitHub: @mohamedSabry0
• Twitter: @mohsmh0
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Validations and Model specs.
• Add more features to the app.
• Add more tests.
• Add more styling.
• Add more features to the app.
• Add more tests.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check issues page.

⭐️ Show your support

If you like this project, kindly drop a start ⭐️ for the repository;

(back to top)

🙏 Acknowledgments

I would like to thank the following individuals and organizations for their contribution to this project.

• I would like to express my heartfelt gratitude to Microvere for the invaluable learning experience they have provided.

(back to top)

📝 License

This project is MIT licensed.

(back to top)