/hello-rails-back-end

Primary LanguageRubyOtherNOASSERTION

Hello Rails Back-end

📗 Table of Contents

📖 React+Rails One Repo App

Hello Rails Back-end is an exercise with 2 repos, but features a random generated greeting message.

Here is the link to the Front-End in React

🛠 Built With

Tech Stack

Server
Database
Front-End

Key Features

  • Setup a Dual Repo APP, using RubyRails Back-end and a React Front-end.
  • Rails 7.1.1 (lastest)+ Postgres
  • Latest React using (create-react-app command)

(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 -v 7.1.1

Setup

Clone both repositories to your desired folder:

  cd your-folder
  git@github.com:cancelei/hello-rails-backend.git

Install

Install this project with:

  cd hello-rails-backend
  bundle install

Setting up the Data Base:

  "Set up Username and password information in the config/database.yml"
  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails s (on port 3000, remember to use port 3001 for front-end)

Deployment

The deployment will be available soon !

(back to top)

👥 Authors

👤 Glauber Bannwart

(back to top)

🔭 Future Features

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

  • User Interface, Controllers and Models
  • [N/A] API documentation
  • 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 creating this exercise-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)