Skip to content

Latest commit

 

History

History
265 lines (175 loc) · 6.35 KB

README.md

File metadata and controls

265 lines (175 loc) · 6.35 KB
Raw

Hello API | Ruby on Rails & ReactJS

📗 Table of Contents

Hello API

"Hello App" This is a simple application for displaying random greetings, made with Ruby on Rails. The application consists of an API in the backend, which has a single endpoint that is consumed from a frontend made with ReactJS and Redux toolkit to manage the global state of the application.

🛠 Built With

Tech Stack

Backend
Frontend

Key Features

  • Ruby on Rails framework
  • Use Linters to check code quality
    • Rubocop
    • Stylelint
  • MVC architectural/design pattern
  • Data persistent in PostgreSQL
  • Frontend with Reactjs, Redux and Webpack
  • RESTful API

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

  • A code editor (we recommend Visual Studio Code)

  • Git and a GitHub account

Setup

Clone this repository to your desired folder by using this 👇️ command :

git clone https://github.com/NitBravoA92/hello-rails-react.git

Install

Go to the project directory:

 cd hello-rails-react

Before to run the program, verify that you have Ruby on Rails installed on your OS running the following command:

 rails --version

It should show you the version of ruby on rails ​​installed. If this does not happen and only an error message is displayed, then you should either verify your installation or install Ruby on Rails from scratch.

Download and Install Ruby on Rails

Once you have verified that you have Ruby on Rails installed, run the following command to install the necessary gems:

 bundle install

After installing the gems, run the following command to create the database:

 rails db:create

Then run the following command to migrate the database:

 rails db:migrate

Then run the following command to install React, Redux, and all the Node packages:

 npm install

if you have any problem with the previous command, try to run the following command:

 yarn install

Usage

Run the following command inside the project folder to start the application:

  npm run build
  rails s

if you have any problem with the previous command, try to run the following command:

 ./bin/dev

Those commands will start the application on your local server. You can now open your browser and go to http://localhost:3000/ to see the application running.

Run linters

To verify that the ruby and CSS code is written without errors and meets good practice standards, run the following command inside the project folder:

  • ruby linter:
 rubocop
  • CSS linter:
 stylelint "**/*.{css,scss}"

(back to top)

👥 Authors

👤 Nitcelis Bravo

(back to top)

🔭 Future Features

Upcoming improvements:

  • Add the endpoints to create, update and delete a greeting
  • Add CSS styles to the app
  • Deploy the application

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project and know someone who might find it helpful, please share it. Or give it a star ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

📝 License

This project is MIT licensed.

(back to top)