jard-client is a frontend for jard, an anonymous imageboard software. For more information about the project check out the main jard repository.
This client is written in TypeScript 3.x (superset of JavaScript) with React 16.x as main library. Requests to REST API are made using axios library, forms are handled by react-hook-form and routing by react-router. Components are styled with styled-components. Design components from semantic-ui-react library are also used. More libraries are used as defined in package.json file.
Master branch is regulary deployed to Heroku.
There are several ways to deploy this client instance:
Probably the most convenient way is to deploy straight to Heroku (PaaS) with this button:
If you prefer to deploy locally on your own computer/VPS, you can use docker-compose to deploy the whole jard stack at once.
See this section in main repository for instructions.
Alternatively, you could deploy just the client container. This requires to have set up PostgresSQL database and linking it via enviroment variables.
- Download / copy the .env-template file, rename it to
.envand fill in the enviroment variables. - Run commands described in docker_run.sh
- Wait ~2 minutes, afterwards you should have jard client running at port defined in
PORTvariable.
If you enable CAPTCHA protection on one or more boards, you may run into issue with hCaptcha not being available on localhost. For more details and possible workarounds please consult hCaptcha docs (section Local Development).
There are several ways for contributing to the project. I will be thankful for all of them.
- Star the repository and share the word
- Open a new issue if you encounter a bug or have feature/improvement request
- Contribute to the code - see CONTRIBUTING.md for details