diff --git a/README.md b/README.md index 73c8698ae4b7cecb57238e2b76849a1471c76663..4adb6e1af0f9655c3f9933d5018c90dcae99c26b 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ Grady is a tool to aid in the process of grading exams at the University of Goettingen, developed at the Institute for Computer Science. -## Description +<!-- ## Description --> -TODO - write some explanatory prose about the purpose and inner workings of Grady... +<!-- TODO - write some explanatory prose about the purpose and inner workings of Grady... --> ## Getting Started @@ -14,12 +14,12 @@ TODO - write some explanatory prose about the purpose and inner workings of Grad If you are using [Nix](https://nixos.org/), all you'll need is: - [devenv](https://devenv.sh/getting-started/) -- [direnv](https://direnv.net/) +- [direnv](https://direnv.net/) (optional, automatically activates devenv shell on entering the project directory) Otherwise, you'll need the following to start developing: -- [Docker](https://docker.com) -- [Bun](https://bun.sh/docs/installation) +- [Docker](https://docs.docker.com/engine/install) +- [Bun](https://bun.sh/docs/installation) or [Node](https://nodejs.org/en/download)/npm <!-- ### Installing --> @@ -27,7 +27,7 @@ Otherwise, you'll need the following to start developing: ### Running the Application -There are two ways to run the application for local development: **with only `devenv`** or **with Docker**. Choose the method that best suits your needs. +There are two ways to run the application for local development: **with only `devenv`** or **with Docker**. --- @@ -45,10 +45,12 @@ devenv up --- -#### Option 2: Running without `devenv` +#### Option 2: Running with **Docker** If you prefer not to use `devenv`, you can start a local SurrealDB instance manually using Docker. +>For installing Docker on your system, refer to the [Docker documentation](https://docs.docker.com/engine/install) + 1. Create a directory to persist the development database (this is needed to ensure correct filesystem permissions): ```sh mkdir -p run/data @@ -72,14 +74,30 @@ docker run --rm --pull always \ ```sh bun install ```` +Or +```sh +npm install +``` 4. Initialize development data ```sh bun --bun run db/manage.ts init ``` +Or +```sh +./db/manage # compiled version incase you don't have Bun available +``` +Or +```sh +npm run dev +``` 5. Start the app ```sh bun --bun run dev ``` +Or +```sh +npm run dev +``` --- diff --git a/src/routes/(app)/+layout.svelte b/src/routes/(app)/+layout.svelte index 9a38a9568ef5185abedc371aa38d619ef140666c..a20e5b149939c687b76bcddc39f15f0b465f0198 100644 --- a/src/routes/(app)/+layout.svelte +++ b/src/routes/(app)/+layout.svelte @@ -41,7 +41,8 @@ <!--<nav>(subheader/trail nav)</nav>--> <!-- Grid Columns --> - <div class="grid grid-cols-1 overflow-hidden md:grid-cols-[auto_1fr]"> + <!--<div class="grid grid-cols-1 overflow-hidden md:grid-cols-[auto_1fr]">--> + <div class="grid grid-cols-[auto_1fr] overflow-hidden"> <!-- Sidebar --> <!-- TODO change for small screen sizes --> <!-- h-full? apply h-screen if sticky -->