Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 3.74 KB

README.md

File metadata and controls

90 lines (65 loc) · 3.74 KB
Raw

License Issues Docker CI/CD Discord YouTube Translations

OpenChia.io Angular Website

All our software (api, pool, bot, web, mobile, proxy) are open source and available on Github.

Building UI

From local

Configure the proxy for the API endpoint in ./src/app/proxy.conf.json and then run:

$ npm i
$ npm run start

After local build, website will be accessible on https://localhost:4200.

From docker

$ docker build -t openchia/web .
$ docker container run --rm --name openchia-web -p 8080:80 openchia/web

After docker build, website will be accessible on http://localhost:8080.

By default caddy listen on port 80 but we bind it to port 8080 which allows you to launch image without root permissions.

Variables available in the docker environment:

  • DOMAIN: website domain (default: localhost)
  • LOGLEVEL: loglevel in stdout (default: INFO)
  • LOGFORMAT: log format in stdout (default: json)

Unit test

Run npm run test to execute the unit tests via Karma.

Translation

We are currently using Crowdin. All you need to do is create an account and translate to your language using the website here.

Security

Code and Docker image are scanned by Trivy. All results are in GitHub Security tab.

Contributing

All contributions are welcome! Please fork main branch and create a new branch, and then create a pull request to the main branch.

Linear merging is enforced on main and merging requires a completed build and review. Please make sure your code/build is passing. The main branch is usually the currently released latest version on website and on the Docker image.

License

OpenChia is made with ♥ by team and it's released under the AGPLv3 license.