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 repository.
This application was built as a group project in less then 3 weeks.
Here is the Kanban Board we planed to work on at the begining of this project.
- Ruby on Rails
- PostgresSQL
- Rspec
- And some other open source ruby gems
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.
- Open your favorite command line tool, and run the bellow commands.
- Run
git clone git@github.com:ichala/short-let-api.git - Run
cd short-let-api - Run
bundle install - Run
cp .env.example .env - Update the
.envfile with proper database credentials - Run
openssl rand -base64 32 - Now copy the generated key from you terminal and use it in your .env file for
JWT_KEY - Run
rails db:create - Run
rails db:migrate
The tests are built with Rspec so you can run the rspec . command to run all of the tests.
👤 Aimal Amiri
- GitHub: @aimalamiri
- Twitter: @meaimal
- LinkedIn: aimalamiri
👤 Eid Hachem
- GitHub: @EidHachem
- Twitter: @eidHachem1
- LinkedIn: Eid Hachem
👤 Ali Jendoubi
- GitHub: @iChala
- LinkedIn: @alijendoubi
👤 Lekan Jimoh
👤 David Lyangenda
- GitHub: @Lyangenda
- Twitter: @Lyangenda
- LinkedIn: LinkedIn
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
- Hat tip to anyone whose code was used
- Inspiration
- etc
This project is MIT licensed.