Skip to content

constantgillet/resthelpdesk

Repository files navigation

RestHelpdesk 📘🆘✌

RestHelpdesk is a small rest API made with Golang for having your own helpdesk API and integrating with your app or web app

Features & planned features

  • Articles & knowledges base with livesearch
  • Tickets support with smtp integration
  • LiveChat
  • React Client
  • Admin dashboard

Requirements

  • Golang (this project has been made on go version go1.16.3)
  • MariaDB or MySQL database

Installation & Launch

Enter this command into the project folder to install go modules

go install

Import databse & set the environnements variables

PORT=8000 # Your app port, default is 8000
DATABASE_URL=mysql://root:@127.0.0.1:3306/resthelpdesk # Your mysql connection url , mysql://username:database_password@host:database_port/database_name

Enter this command into the project folder

 go run main.go

REST API documentation

See documentation to learn how to use the REST API

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

Small helpdesk rest API writed in GO

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published