Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/duanedave/hello-rails-back-end
https://github.com/duanedave/hello-rails-back-end
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/duanedave/hello-rails-back-end
- Owner: DuaneDave
- Created: 2023-01-03T16:12:09.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-21T21:43:14.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T14:20:00.208Z (2 months ago)
- Language: Ruby
- Size: 582 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
GREETING API
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
**Greeting_API** is web app to display greetings from rails API with react as the front-end in two apps.
> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.
Server
Database
- **Setup API endpoints**
- [Live API link](https://greeting-t0aj.onrender.com/greetings)
- [Frontend Reopository PR](https://github.com/DuaneDave/hello-react-front-end/pull/2)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- [Ruby and Rails on you operating system eg. for Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)
- [PostgreSQL](https://www.postgresql.org/) database installed
### Setup
Clone this repository to your desired folder:
```sh
cd my-folder
git clone https://github.com/DuaneDave/hello-react-front-end.git
```
### Install
Install this project with:
```sh
cd hello-rails-back-end
bundle install
```
### Usage
To run the project, execute the following command:
```sh
rails s
```
### Run tests
To run tests, run the following command:
```sh
bin/rails rspec spec
```
### Deployment
You can deploy this project using:
👤 **Obiebi Okiemute David**
- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)
- [x] API authentication
- [x] API documentation
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/DuaneDave/hello-rails-back-end/issues/new).
If you like this project, kindly give me a ⭐️
- I would like to thank [Microverse](https://www.microverse.org/) for inspiring this project
- I would like to appreciate [Render](https://render.com) for the plateform to deploy the API
- **Is Rails still relevant?**
- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)
- **Is it easy to learn Ruby on Rails**
- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)
This project is [MIT](./LICENSE) licensed.