📗 Table of Contents
📖 About the Project💻 Getting Started👥 Authors🔭 Future Features🤝 Contributing- ⭐️ Show your support
- 🙏 Acknowledgements
📝 License
📖 Hello Rails Backend app
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
🛠 Built With
Tech Stack
Backend
Frontend
Database
Key Features
- The App can display random Greeting
- Get the random greeting from API
- Display the random greeting Greeting component
🚀 Link To React_app
To check which greeting you get in json format, navigate to the following url:
- Link To React_app: http://localhost:3000
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
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.
Setup
Clone this project on your local machine using the following command on your terminal:
https://github.com/Olivier-Kango/hello-rails-back-end.git
Install
Run the following command to install all project's dependencies:
bundle install
Run the following command to install Rspec for tests:
gem install rspec
Usage
To run the project, execute the following command:
rails s
Run Tests
Run the following command to catch all style errors:
rubocop
Run the following command for the rspec tests(with details):
rspec ./spec --format documentation
Deployment
You can deploy this project using:
👥 Author
- GitHub: @github_olivier
- Twitter: @twitter_olivier
- LinkedIn: @LinkedIn_olivier
🔭 Future Features
Features to add to the project.
- Deploy the project on Render.com
- Make a Mobile design for the App
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
⭐️ Show your support
Give this project a star if you like it !
🙏 Acknowledgments
I would like to thank:
- Theophile Kango and My cording partners.
❓ FAQ
-
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.
📝 License
This project is MIT licensed.