Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamyunusali/eventify-backend
Eventify is a Full-stack web application. that makes easier to post, reserve and delete events on a click of button. This is the Backend(API) of the System.
https://github.com/iamyunusali/eventify-backend
postgresql rspec-rails ruby ruby-on-rails swagger swagger-ui
Last synced: about 5 hours ago
JSON representation
Eventify is a Full-stack web application. that makes easier to post, reserve and delete events on a click of button. This is the Backend(API) of the System.
- Host: GitHub
- URL: https://github.com/iamyunusali/eventify-backend
- Owner: IamYunusAli
- License: mit
- Created: 2023-01-04T08:25:28.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-19T13:20:54.000Z (almost 2 years ago)
- Last Synced: 2024-12-26T09:25:10.202Z (8 days ago)
- Topics: postgresql, rspec-rails, ruby, ruby-on-rails, swagger, swagger-ui
- Language: Ruby
- Homepage:
- Size: 97.7 KB
- Stars: 5
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Eventify app
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [ER Diagram](#er-diagram)
- [API Documentaion](#api-docs)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
>
**[Eventify APP]**
> Describe the tech stack and include only the relevant sections that apply to your project.
Server | Backend
Database
> Describe between 1-3 key features of the application.
- **[View Events]**'
view different events.
- **[Sign Up and Login ]**'
sign up and login to your account.
- **[Reserve events]**'
reserve events that interest you.
## API Documentaion API Docs
[API DOCS](https://eventifyhub.herokuapp.com/api-docs/)
> Add a link to your deployed project.
- [Live API Endpoints Users](https://eventifyhub.herokuapp.com/users)
- [Live API Endpoints Events](https://eventifyhub.herokuapp.com/events)
- [Live API Endpoints Reserves](https://eventifyhub.herokuapp.com/reserves)
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
```sh
Ruby on Rails
ruby
```
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/IamYunusAli/eventify-backend.git
cd eventify-backend
Open in your favorite editor
```
### Install
Install this project with:
```
bundle install
rails db:create
rails db:migrate
rails db:seed
```
### Usage
To run the project, execute the following command:
```sh
rails s
```
### run-tests
To Test the project, execute the following command:
Test the models
```sh
bundle exec rspec spec/models
```
Test the API endpoint
```sh
rake rswag
```
> Mention all of the collaborators of this project.
👤 **Yunus Ali**
- GitHub: [@IamYunusALi](https://github.com/iamyunusali)
- Twitter: [@IamYunusAli](https://twitter.com/iamyunusali)
- LinkedIn: [Yunus Ali](https://linkedin.com/in/iamyunusali)
👤 *Momanyi Hassan*
- GitHub: [@fullstop125](https://github.com/fullstop125)
- LinkedIn: [momanyi-hassan](https://linkedin.com/in/momanyi-hassan-32a489180)
- Twitter: [@moseshassany](https://twitter.com/moseshassany)
👤 **Betsegaw Sebsibe**
- GitHub: [@betses](https://github.com/betses)
- LinkedIn: [Betsegaw Sebsibe](https://www.linkedin.com/in/betsegaw-sebsibe/)
- Twitter: [@betses](https://www.twitter.com/betse_s/)
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project kindly ⭐️ the repo
> Give credit to everyone who inspired your codebase.
- Microverse for giving us the opportunity
- My coding partners during these capstone
This project is [MIT](./LICENSE) licensed.