Start to build backend base
This commit is contained in:
18
README.md
18
README.md
@@ -6,10 +6,9 @@ Project that expose a simple API to make use of Matrix API. It acts as a Matrix
|
||||
**Known limitations**:
|
||||
|
||||
- Supports only a limited subset of Matrix API
|
||||
- Does not support E2E encryption
|
||||
- Does not support spaces
|
||||
|
||||
Project written in Rust. Releases are published on Docker Hub.
|
||||
Project written in Rust and TypeScript. Releases are published on Docker Hub.
|
||||
|
||||
## Docker image options
|
||||
```bash
|
||||
@@ -17,7 +16,10 @@ docker run --rm -it docker.io/pierre42100/matrix_gateway --help
|
||||
```
|
||||
|
||||
## Setup dev environment
|
||||
|
||||
### Dependencies
|
||||
```
|
||||
cd matrixgw_backend
|
||||
mkdir -p storage/maspostgres storage/synapse storage/minio
|
||||
docker compose up
|
||||
```
|
||||
@@ -42,3 +44,15 @@ Auto-created Matrix accounts:
|
||||
|
||||
Minio administration credentials: `minioadmin` : `minioadmin`
|
||||
|
||||
### Backend
|
||||
```bash
|
||||
cd matrixgw_backend
|
||||
cargo fmt && cargo clippy && cargo run --
|
||||
```
|
||||
|
||||
### Frontend
|
||||
```bash
|
||||
cd matrixgw_frontend
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
Reference in New Issue
Block a user