cancelei/blog-in-rails

Learning to code in Ruby on Rails, while participating in Microverse Remote School.

Blog in Rails App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Blog App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 Blog App

Blog in Rails App empowers the end-users to start a new blog-post, comment and like existing content.

🛠 Built With

Tech Stack

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

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Make use for migrations features from Active Record
• Include Tables for User, Comment, Post, and Like
• Use user authentification and authorizations

(back to top)

💻 Getting Started

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

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@github.com:cancelei/blog-in-rails.git

Install

Install this project with:

  cd blog-app
  bundle install

Setting up the Data Base:

  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails server

Run tests

Before running tests, ensure you've set up the test database:

bin/rails db:migrate RAILS_ENV=test

Note: Given that the aim of this project is to test the application's UI, to see if it works without side effects. We have therefore had to modify the contents of certain files, which could have the effect of falsifying certain Unit tests. We therefore recommend that, rather than running all the tests, you only test the features folder and run

bundle exec rspec ./spec/features

Deployment

The deployment will be available soon !

(back to top)

👥 Authors

👤 Glauber Bannwart

• GitHub: @cancelei
• LinkedIn: Glauber Bannwart

👤 Najibullah Jafari

• GitHub: Najibullah_jafari
• Twitter: Najibullah_jafari
• LinkedIn: Najibullah_jafari

👤 Joseph L Kausi

• GitHub: @Grandi0z
• Twitter: @Joseph_LSK
• LinkedIn: Joseph L Kausi

(back to top)

🔭 Future Features

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

• User Interface
• Validations
• API documentation
• Model Data
• Controllers Testing
• Models Testing
• View Implementation

(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)