Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/youmari/react-rails
https://github.com/youmari/react-rails
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/youmari/react-rails
- Owner: youmari
- Created: 2022-04-26T17:10:47.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2022-04-27T08:09:37.000Z (over 2 years ago)
- Last Synced: 2023-03-05T08:47:35.493Z (over 1 year ago)
- Language: Ruby
- Size: 368 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-rails
> react-rails is a web application that will generate a random greeting for you
# ERD (Entity Relationship Diagram)
- react-rails follows this diagram for creating migration files and database
Additional description about the project and its features.
## Built With
- RUBY
- RUBY ON RAILS
- React-rails
## Gems Used
- Rubocop
- RAILS (v7)
## How to Setup
> You can simply clone or download [this repository](https://github.com/youmari/react-rails.git), and use your favorite browser or code editor to run this program.
- To open this project using vs code ( for this example) or your favorite code editor, you can follow the guide below:
> in your cmd or command line navigate to where this project is located, then:
```bash
cd react-rails
```
> thereafter run
```bash
code .
```
## How to Run the App through terminal
- To run the application through trminal, make sure ruby and rails is installed in your computer then follow the guide below:
> in your cmd or command line navigate to where this project is located, then;
```cmd
cd react-rails
```
## Install Gems
```bash
bundle install
```
> thereafter run the below command to start the server on localhost
```bash
rails s
```
## Set up database
> to create databases on your local machine follow the steps below :
1. First make sure that postgresql installed on your machine
2. make sure that postgresql server is runninng
3. run the following command to create database on your machine
```bash
rake db:create
```
### Update schema file and database
- To run the migration files to update schema and databse simply run the following command :
```bash
rails db:migrate
```
## Testing
> the application has tests written by rspec_rails and capybara to run the tests simply type the below command in the root directory
```bash
rspec
```
## Author
👤 **Youmari**
- GitHub: [@youmari](https://github.com/youmari)
- Twitter: [@yf_omari](https://twitter.com/yf_omari)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/yassine-omari-945114190/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Acknowledgments
- Special thanks for [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) the Owner of the Original design
## Show your support
Give a ⭐️ if you like this project!