thallada/BazaarRealmAPI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix readme

Browse Source
This commit is contained in:
Tyler Hallada 2020-08-01 00:44:05 -04:00
parent 519fcb4c5a
commit eb7706974e
1 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
README.md
View File

@ -3,38 +3,40 @@
1. Install and run postgres. 1. Install and run postgres.
2. Create postgres user and database (and add uuid extension while you're there 2. Create postgres user and database (and add uuid extension while you're there
): ):
createuser shopkeeper ```
createdb shopkeeper createuser shopkeeper
sudo -u postgres -i psql createdb shopkeeper
postgres=# ALTER DATABASE shopkeeper OWNER TO shopkeeper; sudo -u postgres -i psql
\password shopkeeper postgres=# ALTER DATABASE shopkeeper OWNER TO shopkeeper;
postgres=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp"; \password shopkeeper
postgres=# CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
```
3. Save password somewhere safe and then and add a `.env` file to the project 3. Save password somewhere safe and then and add a `.env` file to the project
directory with the contents: directory with the contents:
DATABASE_URL=postgresql://shopkeeper:<password>@localhost/shopkeeper ```
RUST_LOG="shopkeeper=debug" DATABASE_URL=postgresql://shopkeeper:<password>@localhost/shopkeeper
HOST="http://localhost:3030" RUST_LOG="shopkeeper=debug"
HOST="http://localhost:3030"
```
4. Create a new file at `src/db/refinery.toml` with the contents: 4. Create a new file at `src/db/refinery.toml` with the contents:
[main] ```
db_type = "Postgres" [main]
db_host = "localhost" db_type = "Postgres"
db_port = "5432" db_host = "localhost"
db_user = "shopkeeper" db_port = "5432"
db_pass = "<database-password-here>" db_user = "shopkeeper"
db_name = "shopkeeper" db_pass = "<database-password-here>"
4. Run `cargo run -- -m` which will compile the app in debug mode and run the db_name = "shopkeeper"
```
5. Run `cargo run -- -m` which will compile the app in debug mode and run the
database migrations. database migrations.
5. Run `./devserver.sh` to run the dev server (by default it listens at 6. Run `./devserver.sh` to run the dev server (by default it listens at
`127.0.0.1:3030`). `127.0.0.1:3030`).
# Todo # Todo
* Add HTTP header authentication for endpoints that modify an owner's data. * Add update endpoints.
* Add DELETE endpoints for existing resources.
* Add endpoints for the other models. * 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. * 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 * Add rate-limiting per IP address. The `tower` crate has a service that might
be useful for this. be useful for this.