https://github.com/veeso-dev/rust-template

Rust template for my web services
https://github.com/veeso-dev/rust-template

Last synced: about 1 year ago
JSON representation

Rust template for my web services

• Host: GitHub
• URL: https://github.com/veeso-dev/rust-template
• Owner: veeso-dev
• License: mit
• Created: 2023-07-21T18:56:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-22T08:33:19.000Z (over 1 year ago)
• Last Synced: 2025-02-14T16:41:43.758Z (over 1 year ago)
• Language: Rust
• Size: 65.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rust-template

[![license-mit](https://img.shields.io/badge/License-MIT-teal.svg)](https://opensource.org/license/mit/)

[![build-test](https://github.com/veeso-dev/rust-template/actions/workflows/build-test.yml/badge.svg)](https://github.com/veeso-dev/rust-template/actions/workflows/build-test.yml)

[![downloads](https://img.shields.io/crates/d/rust-template.svg)](https://crates.io/crates/rust-template)

[![latest version](https://img.shields.io/crates/v/rust-template.svg)](https://crates.io/crates/rust-template)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

---

- [Rust-template](#rust-template)

  - [About rust-template](#about-rust-template)

  - [Get started](#get-started)

    - [Setup env](#setup-env)

    - [Run with Cargo make](#run-with-cargo-make)

  - [rust-template API](#rust-template-api)

    - [Check](#check)

  - [Contributing and issues](#contributing-and-issues)

  - [Changelog](#changelog)

  - [License](#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

```sh

cp .env.test .env

vim .env

```

```env

WEB_PORT=3001

```

### Run with Cargo make

```sh

cargo make -p production run

```

## rust-template API

### Check

Check web service status:

```txt

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](CONTRIBUTING.md)

---

## Changelog

View rust-template's changelog [HERE](CHANGELOG.md)

---

## License

rust-template is licensed under the MIT license.

You can read the entire license [HERE](LICENSE)