Diegogagan2587/blog-app

README

📗 Table of Contents

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

📖 Blog App

Lear more about this project below:

Blog App is a classic blog website that will show the list of post and empower readers to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

So you want to lear more about the tech we have used for this project?

Client

• CSS
• HTML

Server

• Ruby on Rails
• Pagination: kaminari
• Authentication: devise
• Authorization: CanCanCan
• Test: rspec-rails

Database

• PostgreSQL

Key Features

• Make use fo migrations features from Active Record
• Include Tables like: User, Comment, Post, and Like

(back to top)

🚀 Live Demo

The live demo will be available soon.

(back to top)

💻 Getting Started

Would you like to make use of this project?

To get a local copy up and running, follow these steps. Note: We are assuming you have pre-installed ruby

Prerequisites

In order to run this project you need:

first at all, install rails:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Diegogagan2587/blog-app.git

Install

Install this project with:

  cd blog-app
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run all tests, run the following command:

  bin/rails rspec

or you might prefer instead:

rails rspec

Deployment

The deployment will be available soon !

(back to top)

👥 Authors

Would you like to contact the collaborators of this project?

👤 Diego Vidal Lopez

• GitHub: @Diegogagan2587
• Twitter: @dieg02587
• LinkedIn: Diego Vidal Lopez

(back to top)

🔭 Future Features

We this project can improve, we are planning to include the next features soon:

• User Interface
• Test for controllers
• views like: home page, user page, post page
• Logging form
• Validations
• Authoriztion rules
• API end points
• API documentation
• Model Data
• Model Data

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Would you like to help?

If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for suggestion this project.

(back to top)

❓ FAQ (OPTIONAL)

Learn more about FAQ below:

• How do I fix Linters errors if I modify the project?

  • for rubocop run

  rubocop -A

  • for Stylint run:

  npx stylelint "**/*.{css,scss}" --fix

(back to top)

📝 License

This project is MIT licensed.

(back to top)