Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nkaleth/market_place_ror
Ruby on Rails application
https://github.com/nkaleth/market_place_ror
Last synced: 5 days ago
JSON representation
Ruby on Rails application
- Host: GitHub
- URL: https://github.com/nkaleth/market_place_ror
- Owner: Nkaleth
- Created: 2024-03-01T18:36:07.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-12T04:16:25.000Z (8 months ago)
- Last Synced: 2024-10-10T07:21:18.851Z (about 1 month ago)
- Language: Ruby
- Size: 597 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Market Place API
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 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)
> The Market Place API will provide functionality to create, read, and destroy data related to market place. It will serve as the server-side component responsible for handling requests and managing the database. The React client will interact with this backend to perform actions such as creating new market place and reservations, see the place details, and removing market place from the system.
[Link to the Front End Repo](https://github.com/dennis-every/book-an-appointment-front-end)
[Backend Deployed link](http://boiling-taiga-49294-bcedd3da6f09.herokuapp.com/api-docs/index.html)
Client
Server
Database
- **Data Model**
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/dennis-every/market_place_ror.git
```
### Install
Install this project with:
```sh
cd market_place_ror
bundle
```
### 💾 Database
Create the databases, run migrations, and populate it with seed data:
```sh
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project run the following commands:
```sh
rails s
```
### Run tests
To run tests, run the following command:
```sh
rspec spec --exclude-pattern "spec/integration/api/*_spec.rb"
```
To test the API documentation, run the following command:
```sh
rake rswag:specs:swaggerize
```
👤 **Nilton Segura**
- GitHub: [@Nkaleth](https://github.com/Nkaleth)
- Twitter: [@NoeSeguraL](https://twitter.com/NoeSeguraL)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/niltonsegura/)
- [ ] **Complete the CRUD for market place and reservations.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/dennis-every/market_place_ror/issues).
If you like this project please give it a star 😁🌟✨
Thanks to [Murat Korkmaz](https://www.behance.net/muratk) for the aswesome [design](https://www.behance.net/gallery/26425031/Vespa-Responsive-Redesign).
This project is [MIT](./LICENSE) licensed.