- ๐ About the Project
- ๐ป Getting Started
- ๐ฅ Authors
- ๐ญ Future Features
- ๐ค Contributing
- โญ๏ธ Show your support
- ๐ Acknowledgements
- ๐ License
The Hello Rails Backend app is a simple Rails api project with the an end point that generates random greeting messages, it provide the greeting messages to: Hello_React_Frontend
Backend
Frontend
Database
- The App can display random Greeting
- Get the random greeting from API
- Display the random greeting Greeting component
To check which greeting you get in json format, navigate to the following url:
- Link To React_app: http://localhost:3000
To get a local copy up and running, follow these steps.
In order to run this project you need:
- IDE or code editor: VsCode, atom, sublime...
- To have Ruby, RoR gem and Git installed on your system.
Clone this project on your local machine using the following command on your terminal:
https://github.com/Olivier-Kango/hello-rails-back-end.git
Run the following command to install all project's dependencies:
bundle install
Run the following command to install Rspec for tests:
gem install rspec
To run the project, execute the following command:
rails s
Run the following command to catch all style errors:
rubocop
Run the following command for the rspec tests(with details):
rspec ./spec --format documentation
You can deploy this project using:
๐ค Olivier Kango
- GitHub: @github_olivier
- Twitter: @twitter_olivier
- LinkedIn: @LinkedIn_olivier
Features to add to the project.
- Deploy the project on Render.com
- Make a Mobile design for the App
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give this project a star if you like it !
I would like to thank:
- Theophile Kango and My cording partners.
-
Do I have to have any previous knowledge about ruby to use this project?
- No!
-
How to use this project?
- check the Getting Started section to have a complete guid on how to setup and run teh project.
This project is MIT licensed.