Skip to content

Latest commit

 

History

History
96 lines (61 loc) · 2.46 KB

README.md

File metadata and controls

96 lines (61 loc) · 2.46 KB
Raw

Simple CRM Lead Management System

The Simple CRM Lead Management System is a Go application that provides a RESTful API for managing leads. It utilizes the Fiber web framework and the GORM ORM library to handle HTTP requests and interact with a SQLite database.

Features

  • Retrieve all leads
  • Retrieve a specific lead by ID
  • Create a new lead
  • Delete an existing lead

Prerequisites

Before running the application, make sure you have the following installed:

  • Go programming language (version 1.16+)
  • SQLite database engine

Installation

  1. Clone the repository:

    git clone https://github.com/coffeedragon96/12-go-fiber-simpleCRM.git

  2. Navigate to the project directory:

    cd 12-go-fiber-simpleCRM

  3. Install the dependencies:

    go mod download

  4. Initialize the SQLite database:

    touch leads.db

  5. Run the application:

    go run main.go

  6. The application will be available at http://localhost:3000.

API Endpoints

The following API endpoints are available:

  • GET /api/v1/lead: Retrieve all leads.
  • GET /api/v1/lead/:id: Retrieve a specific lead by ID.
  • POST /api/v1/lead: Create a new lead.
  • DELETE /api/v1/lead/:id: Delete an existing lead.

Usage

You can interact with the API endpoints using an HTTP client, such as cURL or Postman. Here are some examples:

  • Retrieve all leads:

    curl http://localhost:3000/api/v1/lead

  • Retrieve a specific lead by ID:

    curl http://localhost:3000/api/v1/lead/1

  • Create a new lead:

    curl -X POST -H "Content-Type: application/json" -d '{"name":"John Doe","company":"ACME Inc","email":"[email protected]","phone":123456789}' http://localhost:3000/api/v1/lead

  • Delete an existing lead:

    curl -X DELETE http://localhost:3000/api/v1/lead/1

Database

The application uses an SQLite database to store lead information. The database file leads.db will be created in the project directory when you run the application. The database schema will be automatically migrated upon starting the application.

Conclusion

The Simple CRM Lead Management System provides a simple and efficient way to manage leads through a RESTful API. You can use the provided API endpoints to retrieve, create, and delete leads in the SQLite database. Feel free to customize the application according to your specific requirements and extend its functionality as needed.