bitque/README.md

81 lines
1.5 KiB
Markdown
Raw Normal View History

2020-03-30 23:36:52 +02:00
# A simplified Jira clone built with seed.rs and actix
2020-05-01 22:34:09 +02:00
Server: [![builds.sr.ht status](https://builds.sr.ht/~tsumanu/jirs/server.yml.svg)](https://builds.sr.ht/~tsumanu/jirs/server.yml?)
Client: [![builds.sr.ht status](https://builds.sr.ht/~tsumanu/jirs/client.yml.svg)](https://builds.sr.ht/~tsumanu/jirs/client.yml?)
2020-05-01 22:21:28 +02:00
https://git.sr.ht/~tsumanu/jirs
2020-03-30 23:36:52 +02:00
## Features
2020-03-30 23:41:26 +02:00
* Actor based asynchronous backend
2020-03-30 23:36:52 +02:00
* Ultra fast functional frontend build with WASM
2020-03-30 23:41:26 +02:00
## How to run it
2020-05-01 22:21:28 +02:00
### Config files
```toml
# web.toml
concurrency = 2
port = "5000"
bind = "0.0.0.0"
ssl = false
```
```toml
# db.toml
concurrency = 2
database_url = "postgres://postgres@localhost:5432/jirs"
```
```toml
# mail.toml
concurrency = 2
user = "apikey"
pass = "YOUR-TOKEN"
host = "smtp.sendgrid.net"
from = "contact@jirs.pl"
```
2020-03-30 23:41:26 +02:00
### 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
```
2020-05-01 21:40:32 +02:00
## Issue trackers
https://todo.sr.ht/~tsumanu/JIRS