A service to notify site owners of errors and typos. After integrating with the site, visitors are able to highlight an error or typo and report it to the administrator. The project works in Java.
Tasks can be discussed in the #hexlet-volunteers channel in the Slack community.
Before you can build this project, you must install and configure the following dependencies on your machine:
- Java 17
- Docker, Docker Compose
To build the final jar:
make build
Install Vagrant and VM provider (Virtualbox).
Run commands:
make vagrant build
make vagrant-run
or just vagrant ssh
, then cd /vagrant
to run commands inside vm
To launch your application's tests, run:
make test
For example, to start a postgresql database in a docker container, run:
make docker-db
make run-dev
make run-dev-docker-db # make start
make clear
For creating new typo
:
POST http://localhost:8080/api/workspaces/{workspace-name}/typos
Content-Type: application/json
Authorization: Token workspace-token
{
"pageUrl": "http://site.com/",
"reporterName": "reporterName",
"reporterComment": "reporterComment",
"textBeforeTypo": "textBeforeTypo",
"textTypo": "textTypo",
"textAfterTypo": "textAfterTypo"
}
This repository is created and maintained by the team and the community of Hexlet, an educational project. Read more about Hexlet.
See most active contributors on hexlet-friends.