From 567f5e63c5a6f6f72954e078d652972a6146267d Mon Sep 17 00:00:00 2001 From: Adrian Wozniak Date: Mon, 30 Mar 2020 23:41:26 +0200 Subject: [PATCH] Add readme --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 200ebfca..4c5f69ca 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,45 @@ ## Features -* Actor based asynchronymous backend +* Actor based asynchronous backend * 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 +```