toushi100 / instabug-backend-challenge

instabug

This project is amazing, you should write some lines about it.

---

Content

• Features
• Prerequisites
• Install
• Technologies
• Documentation
• Database Schema
• Maintainers

Features ✨

• Create chats
• Send messages
• Search through past messages

Prerequisites

Please make sure the followings are installed

• Docker
• Docker compose

Install 🐙

• Clone the repo git clone https://github.com/toushi100/instabug-backend-challenge.git
• cd into the repo cd instabug-backend-challenge
• run the project by docker-compose up

Technologies 💻

• Ruby on Rails
• Sidekiq
• MySQL
• Redis
• Elasticsearch

Documentation 📄

• Here is the list of the RESTful APIs
• Default base URL http://localhost:3000
• Postman Documentation Link

• Application:

  • Index GET /v1/applications
  • Create POST /v1/applications
  • Update PUT /v1/applications/:token
  • Show GET /v1/applications/:token

• Chats:

  • Index GET /v1/applications/:token/chats
  • Create POST /v1/applications/:token/chats
  • Show GET /v1/applications/:token/chats/:number

• Messages:

  • Index GET /v1/applications/:token/chats/:number/messages
  • Create POST /v1/applications/:token/chats/:number/messages
  • Destroy DELETE /v1/applications/:token/chats/:number/messages/:message_number
  • Search GET /v1/applications/:token/chats/:number/messages/search?q={batata}

Database Schema 💾

• The database consists of there tables
  • Applications
  • Chats
  • Messages
  

Maintainers 👷

Ahmed Salah 💻