README.md

Rust-template

---

• Rust-template
  • About rust-template
  • Get started
    • Setup env
    • Run with Cargo make
  • rust-template API
    • Check
  • Contributing and issues
  • Changelog
  • License

---

About rust-template

rust-template is a Rust web service which comes integrated with ClamAV. The service provides an API endpoint to scan files with ClamAV.

---

Get started

Setup env

cp .env.test .env
vim .env

WEB_PORT=3001

Run with Cargo make

cargo make -p production run

rust-template API

Check

Check web service status:

GET /check

Response: Empty (200)

---

Contributing and issues

Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve pavao, feel free to open an issue or a PR.

Please follow our contributing guidelines

---

Changelog

View rust-template's changelog HERE

---

License

rust-template is licensed under the MIT license.

You can read the entire license HERE