https://github.com/kkasaija/hello-rails-back-end
A hello-rails-app serving as an example of a typical API
https://github.com/kkasaija/hello-rails-back-end
postgresql ruby ruby-on-rails
Last synced: 11 months ago
JSON representation
A hello-rails-app serving as an example of a typical API
- Host: GitHub
- URL: https://github.com/kkasaija/hello-rails-back-end
- Owner: kkasaija
- Created: 2023-03-01T21:55:42.000Z (over 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-03-17T00:14:28.000Z (over 3 years ago)
- Last Synced: 2024-06-15T07:36:09.186Z (about 2 years ago)
- Topics: postgresql, ruby, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 609 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📗 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 (OPTIONAL)](#faq)
- [📝 License](#license)
> Describe your project in 1 or 2 sentences.
**[Hello-rails-back-end]** is an API only based rails project providing resource end points that can be used with different front end technologies
Client
Database
> Describe between 1-3 key features of the application.
- **[Serve API]**
> Add a link to your deployed project.
- [Live Demo Link](https://google.com)
## [link to react app](https://github.com/Kasaija-Kenneth/hello-react-front-end)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
> - `A text editor of your liking`
> - [Download and Install git](https://git-scm.com/)
> - [Download and install ruby from this link](https://rubyinstaller.org/)
> - [Download and Install postgresql](https://www.postgresql.org/)
> - [Install yarn from this link](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
> - `gem install rails`
> - [You need to have a github account or create one](https://github.com/)
### Setup
Clone this repository to your desired folder:
> `git clone https://github.com/Kasaija-Kenneth/hello-rails-back-end.git`
> cd `hello-rails-back-end`
### Install
To Install this project with, make sure you have administrator permissions, then:
> cd `hello-rails-back-end`
> `bundle install`
### Usage
To run the project, execute the following command:
> `./bin/dev`
### Run tests
To run tests, run the following command:
### Deployment
You can deploy this project using:
> Mention all of the collaborators of this project.
👤 **KASAIJA KENNETH**
- [GitHub:](https://github.com/Kasaija-Kenneth)
- [Twitter:](https://twitter.com/kenn_ug)
- [LinkedIn:](https://www.linkedin.com/in/kasaija-kenneth/)
> Describe 1 - 3 features you will add to the project.
- [x] **[To be communicated]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Kasaija-Kenneth/hello-rails-back-end/issues).
> Write a message to encourage readers to support your project
If you like this project...
This project is [MIT](https://github.com/Kasaija-Kenneth/hello-rails-back-end/blob/api/MIT.md) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._