Changeset fe28254 for README.md


Ignore:
Timestamp:
08/07/26 03:00:46 (8 weeks ago)
Author:
Stefan <trsunovstefan@…>
Branches:
main
Children:
df05838
Parents:
b715712
Message:

Fix readme

File:
1 edited

Legend:

Unmodified
Added
Removed

  • README.md

    rb715712 rfe28254  
    44*Databases 2025/2026 Winter*, FINKI UKIM.
    55
    6 Full documentation lives in [`docs/`](docs/) — start at [`docs/README.md`](docs/README.md),
    7 which is the project front page and links every phase. Detailed build and test
    8 instructions are in [`docs/P4-Prototype/BuildInstructions.md`](docs/P4-Prototype/BuildInstructions.md).
    96
    107## Run it in four commands
    118
    129```sh
    13 cp .env.example .env          # local defaults: postgres on port 5433
    14 docker compose up -d          # start PostgreSQL
     10cp .env.example .env         
     11docker compose up -d         
    1512go build -o eduberza ./server
    16 ./eduberza -init              # create the `project` schema + load sample data
    17 ./eduberza                    # start the CLI
     13./eduberza -init             
     14./eduberza                   
    1815```
    19 
    20 Log in as `alice` / `test123` (also `bob`, `charlie` — same password).
    21 
    22 `./eduberza -init` is destructive and idempotent: it drops and recreates the
    23 `project` schema every time, so it is the reset button whenever a demo goes
    24 sideways. `./eduberza -load-data` reloads only the sample data.
    25 
    26 Optional — watch prices move while you trade, in a second terminal:
    27 
    28 ```sh
    29 go run ./bots
    30 ```
    31 
    32 ## Layout
    33 
    34 | Path | What |
    35 |------|------|
    36 | `server/` | CLI prototype — one file per use-case area |
    37 | `server/db/schema_creation.sql` | DDL: drops + recreates the `project` schema (P2) |
    38 | `server/db/data_load.sql` | DML: truncates + reloads sample data (P2) |
    39 | `bots/` | Market simulation bot — random-walk trades and 1m candles |
    40 | `docs/` | All phase documentation, ER diagram, use cases |
    41 
    42 Both SQL scripts are embedded into the binary at build time, so `-init` works
    43 from any working directory.
    44 
    45 ## Requirements
    46 
    47 Go 1.25+, Docker (or any reachable PostgreSQL 14+), and optionally `psql`.
    48 Editing the ER diagram additionally needs Java and TerraER — see
    49 [`docs/P4-Prototype/BuildInstructions.md`](docs/P4-Prototype/BuildInstructions.md).
Note: See TracChangeset for help on using the changeset viewer.