Update README.md

This commit is contained in:
Abhinav Raut
2025-02-12 23:50:02 +05:30
committed by GitHub
parent 7efe811e52
commit 8626f72b22

View File

@@ -1,8 +1,39 @@
# Libredesk
Self-hosted fully open-source customer support desk. Single binary app.
Open-source, self-hosted customer support desk. Single binary app.
> This project is currently in **alpha**. Features and APIs may change and are not yet fully tested.
### Developer Setup
#### Prerequisites
- **go**
- **pnpm**
- **PostgreSQL >= 13**
- **Redis**
1. **Clone the repository**:
```bash
git clone https://github.com/abhinavxd/libredesk.git
cd libredesk
```
2. **Configure the Application**:
- Copy the sample configuration file `config.toml.sample` to `config.toml`:
```bash
cp config.toml.sample config.toml
```
- Edit the `config.toml` file to configure your database and Redis connection settings.
3. **Run in Development Mode**:
- Backend: `make run-backend`
- Frontend: `make run-frontend`
---
Visit [libredesk.io](https://libredesk.io) for more info.