Add readme
This commit is contained in:
parent
0e23ef4fc6
commit
567f5e63c5
42
README.md
42
README.md
@ -2,5 +2,45 @@
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Actor based asynchronymous backend
|
* Actor based asynchronous backend
|
||||||
* Ultra fast functional frontend build with WASM
|
* Ultra fast functional frontend build with WASM
|
||||||
|
|
||||||
|
## How to run it
|
||||||
|
|
||||||
|
### Local variables
|
||||||
|
|
||||||
|
Within `jirs` directory place `.env` file with following content
|
||||||
|
|
||||||
|
```dotenv
|
||||||
|
DATABASE_URL=postgres://postgres@localhost:5432/jirs
|
||||||
|
RUST_LOG=actix_web=info,diesel=info
|
||||||
|
JIRS_CLIENT_PORT=7000
|
||||||
|
JIRS_CLIENT_BIND=0.0.0.0
|
||||||
|
JIRS_SERVER_PORT=5000
|
||||||
|
JIRS_SERVER_BIND=0.0.0.0
|
||||||
|
NODE_ENV=development
|
||||||
|
DEBUG=true
|
||||||
|
```
|
||||||
|
|
||||||
|
### Backend
|
||||||
|
|
||||||
|
Requirements:
|
||||||
|
|
||||||
|
* PostgreSQL
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo install diesel_cli --no-default-features --features postgres
|
||||||
|
diesel setup
|
||||||
|
diesel migration run
|
||||||
|
|
||||||
|
cargo run --bin jirs_server
|
||||||
|
```
|
||||||
|
|
||||||
|
### Frontend
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
|
||||||
|
cd jirs_client
|
||||||
|
yarn
|
||||||
|
yarn webpack-dev-server
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user