TinyCRM

TinyCRM is a lightweight, efficient Customer Relationship Management (CRM) system that streamlines interaction management, support ticketing, and ticket comment tracking.

---

📋 Table of Contents

• Introduction
• Prerequisites
• Running the Application
• API Endpoints
• Usage
• Authors
• License

---

🛠 Introduction

TinyCRM is built for organizations looking for a simple yet powerful tool to manage customer interactions, support tickets, and related comments. The system comprises:

• Backend: Spring Boot
• Frontend: Vue.js
• Database: MySQL

This application is containerized with Docker, ensuring smooth setup and deployment.

---

⚙️ Prerequisites

Ensure the following tools are installed before running the application:

• Docker
• Docker Compose
• Java 11 or higher
• Node.js and npm
• Gradle

---

🚀 Running the Application

Follow these steps to start the application:

1. Clone the repository

   git clone https://github.com/spkdroid/TinyCRM.git
   cd TinyCRM

2. Start the application using Docker Compose:

   docker-compose up --build

   This command will build and start all services defined in the docker-compose.yml file, including the Spring Boot backend, Vue.js frontend, and MySQL database.

3. Access the application:
   Open your browser and navigate to http://localhost:8080.

---

📚 API Endpoints

🎫 Ticket Endpoints

• Create a Ticket

  POST /api/tickets
  Body: { "title": "Issue title", "description": "Issue description" }

• Retrieve All Tickets

  GET /api/tickets

• Retrieve a Ticket by ID

  GET /api/tickets/{id}

• Delete a Ticket by ID

  DELETE /api/tickets/{id}

💬 Comment Endpoints

• Add a Comment to a Ticket

  POST /api/tickets/{ticketId}/comments
  Body: { "text": "Comment text" }

• Retrieve Comments for a Ticket

  GET /api/tickets/{ticketId}/comments

---

💻 Usage

Filing a Support Ticket

1. Navigate to the /file-ticket route in the application.
2. Enter the ticket title and description in the provided form.
3. Submit the form to create a new ticket.

Viewing and Managing Comments

1. Go to the /ticket-comments route in the application.
2. View all comments associated with a ticket.
3. Use the form to add new comments to an existing ticket.

---

👨‍💻 Authors

• Ramkumar Velmurugan
  Portfolio

---

📝 License

Copyright 2024 Ramkumar Velmurugan

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at:

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.