https://github.com/luigirazum/book-destinations-api
https://github.com/luigirazum/book-destinations-api
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/luigirazum/book-destinations-api
- Owner: luigirazum
- License: mit
- Created: 2024-03-07T08:23:55.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-03-22T14:01:06.000Z (over 1 year ago)
- Last Synced: 2025-01-11T01:12:00.278Z (9 months ago)
- Language: Ruby
- Size: 76.2 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Book Destinations 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)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
**[Book Destinations Api]** is a Api only application that acts as the server for the client app. The application provides data through api and also handle user authentication. Here is a link to the Client App. [FrontEnd](https://github.com/Obimbo07/hello-rails-frontend/tree/feature/app-setup).
Ruby on Rails
Database
- **[Database schema contains messages table to store data]**
- **[Api only application]**
> Not live yet...
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
Example command:
```sh
gem install rails
```
### Setup
Clone this repository to your desired folder:
Example commands:
```sh
cd book-destinations-api
git clone git@github.com:/.git
```
-
### Install
Install this project with:
Example command:
```sh
cd book-destinations-api
gem install
```
-
### Usage
To run the project, execute the following command:
Example command:
```sh
rails server
```
-
### Run tests
To run tests, run the following command:
Example command:
```sh
bin/rails test
```
-
### Deployment
You can deploy this project using:
render
👤 **Austin Obimbo**
- GitHub: [@obimbo07](https://github.com/obimbo07)
- LinkedIn: [LinkedIn](https://linkedin.com/in/austin-obimbo)
- WellFound: [WellFound](https://wellfound/u/austin-obimbo)
👤 **Vikas Chib**
- GitHub: [@vikas924](https://github.com/vikas924)
- Twitter: [@vikas410190](https://twitter.com/vikas410190)
- LinkedIn: [Vikas Singh](https://www.linkedin.com/in/vikas-singh-586a07132/)
- [ ] **[Implement payment models and logic]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project give it a Star and come contribute new features. We welcome you all.
We would like to thank microverse for their guidance on the project.
> Add at least 2 questions new developers would ask when they decide to use your project.
- **[Can I contribute?]**
- [Yes, your welcome to contribute, We value pair-programming]
This project is [MIT](./License) licensed.