https://github.com/riipandi/rusttp
Minimal full-stack Rust and Vite starter project template for building application with Axum and Clap.
https://github.com/riipandi/rusttp
axum boilerplate clap-rs postgres rest-api rust sqlx starter-template
Last synced: about 2 months ago
JSON representation
Minimal full-stack Rust and Vite starter project template for building application with Axum and Clap.
- Host: GitHub
- URL: https://github.com/riipandi/rusttp
- Owner: riipandi
- License: apache-2.0
- Created: 2025-04-08T10:05:53.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-18T20:00:26.000Z (3 months ago)
- Last Synced: 2026-04-26T17:34:03.224Z (2 months ago)
- Topics: axum, boilerplate, clap-rs, postgres, rest-api, rust, sqlx, starter-template
- Language: Rust
- Homepage: http://localhost:8000
- Size: 87.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yaml
- License: LICENSE-APACHE
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🦀 Rusttp
[](https://www.rust-lang.org/)
[](https://github.com/riipandi/rusttp/releases)
[](https://github.com/riipandi/rusttp/actions/workflows/test.yml)
[](https://github.com/riipandi/rusttp/actions/workflows/release.yml)
[](https://github.com/riipandi/rusttp/graphs/contributors)
---
Minimal Rust starter project template for building application with Axum and Clap.
> [!NOTE]
> _This is a template for [cargo-generate](https://cargo-generate.github.io/cargo-generate/)._
> _Read the [documentation](#quick-start) to get started._
## Quick Start
You will need `Rust >=1.82`, `Docker >= 27.5`, and `Docker Compose >= 2.32` installed on your machine.
### Create New Project
Install [`cargo-generate`](https://crates.io/crates/cargo-generate) sub-command then execute:
```sh
cargo generate riipandi/rusttp -b main -n myapp-name
```
> Don't forget to change `myapp-name` with your real application name.
### Up and Running
1. Install the required toolchain & SDK: [Rust][install-rust], [Docker][docker], [watchexec][watchexec], [just][just], and [lefthook][lefthook].
2. Create `.env` file or copy from `.env.example`, then configure required variables.
3. Generate application secret key, use this command: `just generate-key`
4. Run project in development mode: `just dev`
Type `just` on your terminal to see available tasks.
## Docker Container
### Development Server
```sh
# Start development server
docker-compose -f compose.yaml up -d --remove-orphans
# Stop development server
docker-compose -f compose.yaml down --remove-orphans
```
### Build Container
```sh
docker build -f Dockerfile . -t rusttp:latest
```
### List Docker Image
```sh
docker image list --filter reference=rusttp:latest
```
### Testing Container
```sh
docker run --network=host --rm -it --env-file .env --name rusttp rusttp:latest
```
### Push Images
Sign in to container registry:
```sh
echo $REGISTRY_TOKEN | docker login REGISTRY_URL --username YOUR_USERNAME --password-stdin
```
Replace `REGISTRY_URL` with your container registry, ie: `ghcr.io` or `docker.io`
Push docker image:
```sh
docker push REGISTRY/ORG/rusttp:latest
```
## Deployment
Read [DEPLOY.md](./DEPLOY.md) for detailed documentation.
## Contributions
Welcome, and thank you for your interest in contributing to this project! There are many ways in which you can contribute,
beyond writing code. You can read this repository’s [Contributing Guidelines](./CONTRIBUTING.md) to learn how to contribute.
## License
Licensed under either of [Apache License 2.0][license-apache] or [MIT license][license-mit] at your option.
> Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you,
> as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Copyrights in this project are retained by their contributors.
See the [LICENSE-APACHE](./LICENSE-APACHE) and [LICENSE-MIT](./LICENSE-MIT) files for more information.
---
🤫 Psst! If you like my work you can support me via [GitHub sponsors](https://github.com/sponsors/riipandi).
[][riipandi-x]
[docker]: https://docs.docker.com/engine/install/
[install-rust]: https://www.rust-lang.org/tools/install
[just]: https://just.systems/man/en/
[lefthook]: https://lefthook.dev/installation/index.html
[license-apache]: https://choosealicense.com/licenses/apache-2.0/
[license-mit]: https://choosealicense.com/licenses/mit/
[riipandi-x]: https://x.com/intent/follow?screen_name=riipandi
[watchexec]: https://github.com/watchexec/watchexec