API for the Bazaar Realm Skyrim mod
src | ||
test_data | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
devserver.sh | ||
README.md |
Development Setup
- Install and run postgres.
- Create postgres user and database (and add uuid extension while you're there ): createuser shopkeeper createdb shopkeeper sudo -u postgres -i psql postgres=# ALTER DATABASE shopkeeper OWNER TO shopkeeper; \password shopkeeper postgres=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
- Save password somewhere safe and then and add a
.env
file to the project directory with the contents: DATABASE_URL=postgresql://shopkeeper:@localhost/shopkeeper RUST_LOG="shopkeeper=debug" HOST="http://localhost:3030" - Create a new file at
src/db/refinery.toml
with the contents: [main] db_type = "Postgres" db_host = "localhost" db_port = "5432" db_user = "shopkeeper" db_pass = "" db_name = "shopkeeper" - Run
cargo run -- -m
which will compile the app in debug mode and run the database migrations. - Run
./devserver.sh
to run the dev server (by default it listens at127.0.0.1:3030
).
Todo
- Add HTTP header authentication for endpoints that modify an owner's data.
- Add DELETE endpoints for existing resources.
- Add endpoints for the other models.
- Add caching. Not sure how to do this exactly. Could use Redis, Varnish, Nginx, or a lib resident in the rust web server process. I'll probably need to do invalidations as transactions are made, or interiors are updated.
- Make self-contained docker container that can run the app without any setup.
- Add rate-limiting per IP address. The
tower
crate has a service that might be useful for this.