mirror of
				https://github.com/abhinavxd/libredesk.git
				synced 2025-11-03 21:43:35 +00:00 
			
		
		
		
	Update README.md
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							@@ -3,23 +3,25 @@
 | 
			
		||||
 | 
			
		||||
# Libredesk
 | 
			
		||||
 | 
			
		||||
Fully 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.
 | 
			
		||||
Open source, self-hosted customer support desk. Single binary app.
 | 
			
		||||
 | 
			
		||||
Visit [libredesk.io](https://libredesk.io) for more info. Check out the [**Live demo**](https://demo.libredesk.io/).
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
> [!CAUTION]
 | 
			
		||||
> 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**
 | 
			
		||||
- **postgreSQL >= 13**
 | 
			
		||||
- **redis**
 | 
			
		||||
 | 
			
		||||
1. **Clone the repository**:
 | 
			
		||||
 | 
			
		||||
@@ -37,7 +39,7 @@ Visit [libredesk.io](https://libredesk.io) for more info. Check out the [**Live
 | 
			
		||||
       ```
 | 
			
		||||
   - Edit the `config.toml` file to configure your postgres and redis connection settings.
 | 
			
		||||
 | 
			
		||||
3. **Run in Development Mode**:
 | 
			
		||||
3. **Run in development mode**:
 | 
			
		||||
 | 
			
		||||
   - Backend: `make run-backend`
 | 
			
		||||
   - Frontend: `make run-frontend`
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user