Tsumanu/bitque
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A simplified Jira clone built with seed.rs and actix
149 Commits 5 Branches 3 Tags 23 MiB
Rust 72.9%
SCSS 25.6%
PLpgSQL 0.9%
Shell 0.3%
Dockerfile 0.2%
a2cc744f62
Go to file
Adrian Woźniak a2cc744f62
Create CODE_OF_CONDUCT.md (#1)
2020-05-07 15:40:28 +02:00
.builds Fix client build 2020-05-02 14:07:13 +02:00
.github Create FUNDING.yml 2020-05-07 15:37:21 +02:00
jirs-cli Initial commit 2020-03-27 12:17:27 +01:00
jirs-client Merge branch 'master' of git.sr.ht:~tsumanu/jirs 2020-05-06 22:25:07 +02:00
jirs-css Fix styled input css. Fix css watch mode. 2020-05-02 21:55:31 +02:00
jirs-data Merge branch 'master' of git.sr.ht:~tsumanu/jirs 2020-05-06 22:25:07 +02:00
jirs-server Fix seed and migration 2020-05-06 23:44:48 +02:00
tmp Add upload image 2020-05-05 08:33:40 +02:00
_config.yml Set theme jekyll-theme-minimal 2020-05-07 15:38:30 +02:00
.env Reduce update issue payload. Create config files 2020-04-17 14:10:05 +02:00
.gitignore Update user avatar 2020-05-05 16:09:26 +02:00
Cargo.lock Add upload image 2020-05-05 08:33:40 +02:00
Cargo.toml Build css with rust 2020-04-23 14:26:43 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#1) 2020-05-07 15:40:28 +02:00
CONTRIBUTING.md Add CONTRIBUTING 2020-03-30 21:26:35 +00:00
docker-compose.yml Add queries 2020-03-27 16:17:25 +01:00
LICENSE Add LICENSE 2020-03-30 21:19:29 +00:00
README.md Update user avatar 2020-05-05 16:09:26 +02:00

README.md

A simplified Jira clone built with seed.rs and actix

Server: builds.sr.ht status Client: builds.sr.ht status

https://git.sr.ht/~tsumanu/jirs

Features

  • Actor based asynchronous backend
  • Ultra fast functional frontend build with WASM

How to run it

Config files

WEB

# web.toml
concurrency = 2
port = "5000"
bind = "0.0.0.0"
ssl = false
tmp_dir = "./tmp"

[s3]
access_key_id = ""
secret_access_key = ""
bucket = ""
region_name = "eu-central-1"

[filesystem]
store_path = ""
client_path = "/img"
Upload local storage

If default feature "local-storage" is on your uploaded files will be stored on your machine. This requires additional configuration.

[filesystem]
store_path = "/var/jirs/uploads"
client_path = "/img"
  • store_path is your local machine path. Files will be saved there. This can be relative to CWD path or absolute path.
  • client_path is web path

Both must be set and non-empty

Upload to AWS S3

If default feature "aws-s3" is on your uploaded files will be send to AWS S3 service. This requires additional configuration.

[s3]
access_key_id = ""
secret_access_key = ""
bucket = ""
region_name = "eu-central-1"

Database

# db.toml
concurrency = 2
database_url = "postgres://postgres@localhost:5432/jirs"

Mail Service

You can send e-mail only via service which will handle this. This application was build using sendgrid.

# mail.toml
concurrency = 2
user = "apikey"
pass = "YOUR-TOKEN"
host = "smtp.sendgrid.net"
from = "contact@jirs.pl"

Local variables

Within jirs directory place .env file with following content

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

Client and Server bind/port must be provided. Client will be build using those variables and will send requests only using this address. DATABASE_URL is required only to setup database. Runtime will use db.toml.

Backend

Requirements:

  • PostgreSQL
cargo install diesel_cli --no-default-features --features postgres
export DATABASE_URL=postgres://postgres@localhost/jirs
diesel setup
diesel migration run

cargo run --bin jirs_server

Frontend

curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
cd jirs_client
yarn
yarn webpack-dev-server

Issue trackers

https://todo.sr.ht/~tsumanu/JIRS