https://github.com/connor-davis/threereco-backend-v2
https://github.com/connor-davis/threereco-backend-v2
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/connor-davis/threereco-backend-v2
- Owner: connor-davis
- Created: 2024-07-07T22:49:54.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-08-02T10:56:56.000Z (10 months ago)
- Last Synced: 2025-01-30T01:42:22.042Z (4 months ago)
- Language: Rust
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### Thusa Template
#### Template Type: API
#### Template Stack
1. Axum
2. SQLX
3. Postgres
#### Template Description
This is the Thusa API template that uses axum, sqlx and postgres to lay out a basic api server. No need to worry about migrations being run, as long as the database is created and you have migrations in the "migrations" directory, the server will run migrations.
#### Template Author: Connor Davis <>
### Template Instructions
1. Clone the repository with (note: you can choose the directory by replacing "./thusa-axsqpg-template")
```bash
git clone https://github.com/connor-davis/thusa-axsqpg-template.git ./thusa-axsqpg-template
```
2. Change directory into the folder
```bash
cd ./thusa-axsqpg-template
```
3. Build the project
```bash
cargo build
```
4. Run the project
```bash
cargo run
```
### Migrations instructions
Well if you are looking here, you don't trust the server automatically running migrations. Here is the instruction list on how to run migrations.
1. Ensure that the database url is in the .env file
```env
DATABASE_URL="postgres://postgres:password@localhost:5432/database"
```
2. Run the database creation command. (This template assumes that you have sqlx install globally)
```bash
sql db create
```
3. Run the migration run command.
```bash
sqlx migrate run
```
4. Revert migrations if needed.
```bash
sqlx migrate revert
```