J2ZROMERO/blog_app

📗 Table of Contents

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

📖 Blog app

This is a project that is going to work as a blog app with the necessary characteristics to make it interactive.

🛠 Built With

Tech Stack

Client

• Viual Studio Code

Server

• Ruby

Database

• PostgreSQL

Key Features

The next key features are availble in this project.

• Register yourself as a new user.
• Load the project with prepared data once it is set it up.
• Interaction with model and custom methods.
• Add posts.
• Add likes to posts.
• Execute Capybara tests.
• Ahutorization for the comments and posts with priority, 'admin' can manage those and the others users just what them have created.
• In the seed file only the user with the email jose@hotmail.com that has the id=1 has the admin priority.

(back to top)

🚀 Live Demo

You can see the deployment once it is executed in the next link.

• rails server

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Install a text-editor you prefer. Code editors.

You need a database

• SQLlite
• MySQL
• Postgresql

Ruby

Ruby on Rails Framework

Setup

Clone this repository to your desired folder:

You must have an account on git hub. Git Hub

You must have installed git in your local environment. Git

If you just want to take a look quickly, make a fork and open the project in the web browser by adding ".dev" instead of ."com" in the repo link.

• Example : https://github.dev/J2ZROMERO/blog_app

Install

Install this project with:

Execute the bundle in your terminal with the path of the directory.

Execute "rails bundle" in your terminal with the specific path in order to add all the gems.

You have to change the data bases' crentials.

When the project si already installed execute:

• rake db:setup or rails db:setup
  • Once this in being executed the nexts actions are generated
  • rake db:create
  • rake db:schema:load
  • rake db:seed

If you already have the project in your local you can pull the lastes commit and execute the next commands:

• rails db:reset
• rails db:migrate:reset
• rails db:seed

Usage

To run the project, execute the following command:

• Once your credential is ready execute

Ruby bin/rails db:setup

• After db:setup is executed the file seed.rb is going to execute immediately this will add prepared data to your database, and you can test the customized methods from models.

• After that execute:

Ruby bin/rails db:migrate

• This command will ensure to load the models to tests it.

• You must be sign in to execute de create comment.

• shows all the users http://localhost:3000/api/user/

• shows all the post by the given user http://localhost:3000/api/user/1

• show the post selected http://localhost:3000/api/user/1/post/7

• show all comments by the given post http://localhost:3000/api/user/1/post/7/comment

• You can add a new comment to the post http://localhost:3000/api/user/1/post/7/comment

  POST /api/user/1/post/7/comment { "text": "Este es mi comentario" "post_id": "7" }

Run tests

• To run the tests please follow the next instruccions.

The gem database_cleaner let us clean all the database before execute the test (:warning This gem only works for test and don't allow any input to the original data base), to use this gem is necesary to add some characteristics to the rails_helper.rb

• Add the next gem : gem 'database_cleaner' to the Gemfile
• Execute: bundle install.
• Ruby bin/rails db:migrate RAILS_ENV=test
  • The code above will ensure to prepare the modules for tests.
• Execute: [ rspec ] if you wan to see all the tests working.
• or execute rspec spec/models/NAME-OF-THE-MODEL_spec.rb if you want to run a especific file.
• If you want to see the tests existing and their definitions please run: " rspec --force-color --format documentation "
• To check the tests's controllers please execute the next command on your root project console: "" rspec spec/requests/ "" you will see all the tests' controllers in execution.
• In order to see Capybara tests you can execute: " rspec spec/interfaces" all the tests. " rspec spec/interfaces/show_posts_spec.rb " single file.

Deployment

You can deploy this project using:

Ruby bin/rails server

• Go to your browser in the next directions to interact with the apps.

http://localhost:3000/ http://localhost:3000/user/745/ http://localhost:3000/user/745/post/ http://localhost:3000/user/745/post/3

• You can change the id's [745 / 3] for another one available on the interfaz.
• The seed file has 3 users with their passwords and emails you can acces with some of the credencials in there, just take a look at those queries in the seed file or log in with your data.
• The Photo field must be an URL like = "https://this_is_myptoho.jpg"

(back to top)

👥 Authors

👤 JOSE ZEPEDA

• GitHub: J2ZROMERO
• Twitter: @JOSEZEPED4
• LinkedIn: JOSE ZEPEDA

(back to top)

🔭 Future Features

The next features will be added.

• Tests.
• React-Redux.
• Fetch data to implement it on the interfaz to make it interactive.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Feel free to share your inquiries to our social links provided and we will help you. Don't forget to gift us a ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank MICROVERSE for preparing the content to work.

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• It can works with another data base

  • Of couser the idea of use postgresql is because it is a powerfull db that is well suited with rails.

• **Linters are necessary

  • If you want to have a redable and clean code it is a good option to choose

(back to top)

📝 License

This project is MIT licensed.

(back to top)