Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/litsynp/rust-axum-todo-api
A Rust example of a todo application with axum.
https://github.com/litsynp/rust-axum-todo-api
askama axum docker postgresql rust sqlx sqlx-cli tokio
Last synced: about 10 hours ago
JSON representation
A Rust example of a todo application with axum.
- Host: GitHub
- URL: https://github.com/litsynp/rust-axum-todo-api
- Owner: litsynp
- Created: 2023-05-22T15:33:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-20T05:08:36.000Z (7 months ago)
- Last Synced: 2024-04-21T05:37:52.709Z (7 months ago)
- Topics: askama, axum, docker, postgresql, rust, sqlx, sqlx-cli, tokio
- Language: Rust
- Homepage:
- Size: 171 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rust-axum-todo-api
A Rust example of a todo application with axum and sqlx.
## Requirements
- Rust
- Postgres
- sqlx
- sqlx-cli
- Docker (optional)
## Dependencies
- axum
- tokio
- sqlx
- sqlx-cli
- serde
- serde_json
- dotenv
- chrono
- utoipa
- askama (for frontend with tailwindcss)
## Run the Application
### Docker
```sh
$ make db:up # make db:down to stop and db:destroy to remove
```
### Database Setup
```sh
$ sqlx database create # create database
$ sqlx migrate run # run migrations
```
### Run (Development)
```sh
$ cargo run
```
If you want to watch for file changes, you can use `cargo watch`:
```sh
$ make watch:install # Install cargo-watch
$ make watch
```
### Run (Production)
```sh
$ cargo build --release
$ ./target/release/rust-todo-api
```
## Swagger / OpenAPI
Access the Swagger UI at [`/swagger-ui`](http://localhost:8000/swagger-ui) and the OpenAPI spec
at [`/api-docs/openapi.json`](http://localhost:8000/api-docs/openapi.json).
You can also use RapiDoc at [`/rapidoc`](http://localhost:8000/rapidoc).
## Troubleshooting
- https://stackoverflow.com/questions/61561165/how-do-i-define-a-datetime-field-in-sqlx-rust
- https://stackoverflow.com/questions/75640266/axum-query-extractor-allow-for-struct-with-optional-fields-to-be-parsed
## CLI
This project includes a CLI to add users to the database.
```sh
$ cargo run --bin add-user -- [email protected] --nickname=user --password=1234
Successfully registered user User { id: 1, email: "[email protected]", password: "1234", nickname: "user", created_at: 2024-04-19T17:14:54.358424Z, updated_at: 2024-04-19T17:14:54.358424Z, deleted_at: None }
```
## Frontend
This project uses askama to render HTML templates.
If you need to access the frontend, you can run the following command:
```sh
$ npm install
$ npm run tailwind:build # or npm run tailwind:watch to watch for changes
```
Go to index page at [`/`](http://localhost:8000/) and login
at [`/login`](http://localhost:8000/login).
You can add, edit and delete todos.