mirror of
https://github.com/abhinavxd/libredesk.git
synced 2025-10-23 05:11:57 +00:00
Update README.md
This commit is contained in:
33
README.md
33
README.md
@@ -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.
|
||||
|
Reference in New Issue
Block a user