https://github.com/mahammad-mostafa/hello-rails-back-end
This is the second project in the full stack capstone of the Microverse program. It is an exercise for using Ruby on Rails as a backend API for a simple page app.
https://github.com/mahammad-mostafa/hello-rails-back-end
api backend-api gitflow-workflow json-api microverse microverse-projects microverse-students mvc-framework object-oriented-programming postgresql rails rails-api rubocop ruby ruby-on-rails
Last synced: 3 months ago
JSON representation
This is the second project in the full stack capstone of the Microverse program. It is an exercise for using Ruby on Rails as a backend API for a simple page app.
- Host: GitHub
- URL: https://github.com/mahammad-mostafa/hello-rails-back-end
- Owner: mahammad-mostafa
- License: mit
- Created: 2024-01-18T15:15:47.000Z (over 1 year ago)
- Default Branch: development
- Last Pushed: 2024-01-20T00:40:22.000Z (over 1 year ago)
- Last Synced: 2024-10-19T01:15:40.648Z (8 months ago)
- Topics: api, backend-api, gitflow-workflow, json-api, microverse, microverse-projects, microverse-students, mvc-framework, object-oriented-programming, postgresql, rails, rails-api, rubocop, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 🏷️ Hello Rails Back End
This is the second project in the full stack capstone module in the **Microverse** program.
Check the below contents for further details about this project.
# 📗 Contents
- [Description](#description)
- [Instructions](#instructions)
- [Authors](#authors)
- [Future](#future)
- [Contributions](#contributions)
- [Support](#support)
- [Acknowledgements](#acknowledgements)
- [License](#license)
# 📖 Description
This repository is about a simple greeting text in a single page.
It includes the backend section of the app where it uses `Rails` with `API` configuration.
It also connects with `PostgreSQL` database & follows the `GitFlow` workflow.
Linter used for `Ruby` is `Rubocop`.
Frontend section is located in this [repository](https://github.com/mahammad-mostafa/hello-react-front-end).
📌 **Tech Stack:**
- Backend language is `Ruby`
- Backend Framework used is `Rails`
- Database used is `PostgreSQL`
📌 **Key Features:**
- Backend for a single page application
- Random text generation on each call
- API endpoint with `json` output
# 🛠️ Instructions
You can easily download or fork this repository and work on it immadiately!
📌 **Prerequisites:**
- `Ruby` language
- `PostgreSQL` database
📌 **Installation:**
- To get all required gem dependencies run
```
bundle install
```
- Create all required databases with
```
rails db:create
```
- Build all table schemas with
```
rails db:migrate
```
- Populate table data with
```
rails db:seed
```
📌 **Development:**
- Run backend server using
```
rails server
```
- Manipulate & process models data through
```
rails console
```
# 👥 Authors
📌 **Mahammad:**
- [GitHub](https://github.com/mahammad-mostafa)
- [Twitter](https://twitter.com/mahammad_mostfa)
- [LinkedIn](https://linkedin.com/in/mahammad-mostafa)
# 🔭 Future
Some additional features I may implement in the project:
- [ ] Implement proper user authentication
- [ ] Add endpoints for `CRUD` operations
# 🤝🏻 Contributions
Wish to contribute to this project?
Contributions, issues, and feature requests are more than welcome!
Feel free to check the [issues](../../issues) page too.
# ⭐️ Support
Like this project? Show your support by starring!
# 🙏🏻 Acknowledgements
I thank everyone at **Microverse** for guiding me through this project.
# 📝 License
This project is [MIT](LICENSE.md) licensed.