https://github.com/ichala/short-let-api
This project is the backend service provider for the Short Let application, which helps the frontend to register, and login using JWT. It also provides many API endpoints to read, write, update, and delete data from all parts of the project. We built a simple and useful documentation for this project so the community can have an idea how to use this.
https://github.com/ichala/short-let-api
database ruby
Last synced: 2 months ago
JSON representation
This project is the backend service provider for the Short Let application, which helps the frontend to register, and login using JWT. It also provides many API endpoints to read, write, update, and delete data from all parts of the project. We built a simple and useful documentation for this project so the community can have an idea how to use this.
- Host: GitHub
- URL: https://github.com/ichala/short-let-api
- Owner: ichala
- Created: 2022-09-14T12:10:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-06T13:55:03.000Z (over 2 years ago)
- Last Synced: 2025-02-02T06:11:15.634Z (4 months ago)
- Topics: database, ruby
- Language: Ruby
- Homepage: https://short-let-api.herokuapp.com/
- Size: 155 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Short Let API
This project is the backend service provider for the Short Let application, which helps the frontend to register, and login using JWT. It also provides many API endpoints to read, write, update, and delete data from all parts of the project. We built a simple and useful documentation for this project so the community can have an idea how to use this.
> Here is a link to the [frontend application](https://github.com/ichala/short-let-frontend) repository.
This application was built as a group project in less then 3 weeks.
## Kanban board
Here is the [Kanban Board](https://github.com/ichala/short-let-api/issues/16) we planed to work on at the begining of this project.
## Built With
- Ruby on Rails
- PostgresSQL
- Rspec
- And some other open source ruby gems
## Live Demo
[Look at the live demo](https://short-let-island.vercel.app)
## Getting Started
Make sure you installed Ruby and PostgresSQL in your machine. Please follow the setup steps in order.
To get a local copy and up and running follow these simple example steps.
1. Open your favorite command line tool, and run the bellow commands.
2. Run `git clone [email protected]:ichala/short-let-api.git`
3. Run `cd short-let-api`
3. Run `bundle install`
4. Run `cp .env.example .env`
5. Update the `.env` file with proper database credentials
6. Run `openssl rand -base64 32`
7. Now copy the generated key from you terminal and use it in your .env file for `JWT_KEY`
8. Run `rails db:create`
9. Run `rails db:migrate`
### Usage
### Run tests
The tests are built with `Rspec` so you can run the `rspec .` command to run all of the tests.
## Authors
👤 **Aimal Amiri**
- GitHub: [@aimalamiri](https://github.com/aimalamiri)
- Twitter: [@meaimal](https://twitter.com/meaimal)
- LinkedIn: [aimalamiri](https://linkedin.com/in/aimalamiri)
👤 **Eid Hachem**
- GitHub: [@EidHachem](https://github.com/EidHachem)
- Twitter: [@eidHachem1](https://twitter.com/eidHachem1)
- LinkedIn: [Eid Hachem](https://linkedin.com/in/eid-hachem)
👤 **Ali Jendoubi**
- GitHub: [@iChala](https://github.com/iChala)
- LinkedIn: [@alijendoubi](https://linkedin.com/in/alijendoubi)
👤 **Lekan Jimoh**
- GitHub: [@d2ndjim](https://github.com/d2ndjim)
- Twitter: [@d2ndjim_](https://twitter.com/d2ndjim_)
- LinkedIn: [Lekan](https://linkedin.com/in/lekanj)
👤 **David Lyangenda**
- GitHub: [@Lyangenda](https://github.com/LYANGEND)
- Twitter: [@Lyangenda](https://twitter.com/david_lyangenda)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-lyangenda-623087151/)
## 🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
## Show your support
Give a ⭐️ if you like this project!
## Acknowledgments
- Hat tip to anyone whose code was used
- Inspiration
- etc
## 📝 License
This project is [MIT](./MIT.md) licensed.