Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ifzarasool/hello-rails-react


https://github.com/ifzarasool/hello-rails-react

Last synced: 6 days ago
JSON representation

Awesome Lists containing this project

README

        

# Hello React-Rails App

A react-rails app to show greetings

## Built With

- Ruby
- Ruby on Rails
- React
- PostgreSQL

## Getting Started

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

## Pre-requisites
Make sure you have Ruby and Rails installed on your computer. If not, you can follow this [tutorial](https://guides.rubyonrails.org/getting_started.html#creating-a-new-rails-project) to install them.

If you don't have PostgreSQL installed, you can follow this [tutorial](https://www.postgresql.org/download/) to install it.

If you don't have yarn installed, you can follow this [tutorial](https://classic.yarnpkg.com/en/docs/install/#debian-stable) to install it.

## Usage
In your terminal, navigate to your current directory and run this code

`git clone https://github.com/deyemiobaa/hello-react-rails-app.git`

Then run

`cd hello-react-rails-app`

Open the project in your favorite code editor. `code .` for VS Code.

- Use the command `bundle install` to install all project dependencies.
- Run `yarn install` to install all the JavaScript dependencies.
- Run `rails db:create db:migrate` to create the database and run migrations.
- You might need to supply a username and password for your PostgreSQL database if you run into an error with the previous step.
- Run `rails db:seed` to seed the database with some sample data.
- Simply navigate to `config/database.yml` and add your username and password to the `username` and `password` fields.
- Type in the terminal `./bin/dev` to start the server then click on `http://127.0.0.1:5000`

## Author

👤 **IFZA Rasool**
- GitHub: [@ifzarasool](https://github.com/IfzaRasool
- Twitter: [@ifzaarain](https://twitter.com/ifzaarain)
- LinkedIn: [@ifza-arain]https://www.linkedin.com/in/ifza-arain/

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/IfzaRasool/hello-rails-react/issues).

## Show your support

Give a ⭐️ if you like this project!

## 📝 License

This project is [MIT](LICENSE) licensed.