- 👋 Introduction
- 🎥 Instructions Video
- 🏗️ Installation
- 🧪 Testing
- 🛝 API Testing
- ⭐️ Future Improvements
- 💪 Challenges
ChatSystemAPI, a RESTful API Rails application designed to facilitate communication between different applications. This solution addresses the need for managing various chats, each containing multiple messages. The API enables reading, creating, and updating resources, and features a dedicated search endpoint for querying message bodies within specific chats. This project emerged as my response to a take-home assignment as part of a company's hiring process. To ensure progress and organization, I utilized a Kanban board, managing tasks and activities efficiently. The Trello board, accessible at this Link, served as a tool for smart and organized project management.
I'm also a visualizer, and in this short video, I demonstrate how to install, start, and run tests in our application using Docker and Postman.
| Tool | Download link |
|---|---|
| Git | Link |
| Docker compose | Link |
| Postman | Link |
- Clone the current repository
git clone git@github.com:od-c0d3r/chat_system_api.git
- Run command to start docker containers
docker-compose up --build
- Now you can do two things
- To run the tests first open up the rails container bash in your terminal
docker-compose exec web bash
- Run the following to run the tests
RAILS_ENV=test rspec -f d- Using the
-fformatting flag along with theddocumentation option to print our tests in a neat, nice coloring look.
- Using the
- After making sure that our containers are up and running
- Open
Postmandesktop and importChatSystemAPI.postman_collection.jsonfile, which will bring the APIs at your fingertips to start using right away.
- Implementing Pagination in the response.
- Enhancing the error handling mechanism.
- Testing Elasticearch & background jobs.