Skip to content

Projeto criado durante o processo trainee da CJR

Notifications You must be signed in to change notification settings

m4ycon/petgato-7

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🐱 Petgatô 7


📄 About

The Petgatô project is an blog, that readers can see posts, login, comment, like and search for posts related to pets, also the author can create, edit posts and manage several parts of the blog. It was develop during CJR's trainee process.


🧰 Technologies used

  • Frontend - ReactJS
    • react-quill
    • styled-components
    • axios
    • react-router-dom
    • html-react-parser
    • react-bootstrap
  • Backend - Ruby on Rails
    • postgresql
    • jbuilder
    • jwt
    • bcrypt
    • CORS
    • mailer

📚 Features implemented

This section lists a bunch of features made through the process.

  • Login / Sign up
    • Validations
  • Forgot password (using mailer)
  • Loading component
  • Home page
    • Posts
      • Tags
      • Like on home page
    • Popular posts
    • Search
    • About author
  • Post page
    • Explore tags section
    • Popular posts
    • Format dates from backend
    • Comment section
      • Comment/reply
        • Report
        • Edit
        • Delete
  • About us page
  • Contact us page
    • Sending email
  • Edit profile page
    • Edit profile image
    • Edit name
    • Edit password
  • Backoffice page / Admin page
    • Tables of posts/tags/users/reports
      • Edit page
      • Delete

🏭 How to install/use

This section describes how to run this app locally at your environment. For this you need to have ruby 2.7.3, postgresql, node, git installed.

  • Backend

First of all, we need to setup some files, starting with config/database.yml, you'll need to define your user and password there, it's simple, there are two pairs of it, don't forget.

This part is optional, just if you want to see the mailer working, go to config/enviroments/development.rb, on the last lines you will need to set some configurations for action_mailer work, like email, password, domain...

If you don't have these gems, install it:

$ gem install bundler
$ gem install rails

Open a shell and get the repository on your local files with:

$ git clone https://github.com/m4ycon/petgato-7.git
$ cd petgato-7/backend
# install the gems
$ bundle install
$ rails db:drop db:create db:migrate db:seed
# start the server
$ rails s
  • Frontend

You can replace npm by yarn, if you have it. Now open another shell and:

$ cd petgato-7/frontend
$ npm install
$ npm start

And finally you can access the app on http://localhost:3000

Happy hacking!


Made by Maycon Fabio, Vitor Lemos and Herisson Nobre 🚀