From 6f2858256c0aff88dda6209d2e40cd6dc487e643 Mon Sep 17 00:00:00 2001 From: "Jord Gui [SSW]" <41951199+Jord-Gui@users.noreply.github.com> Date: Thu, 9 Nov 2023 11:34:59 +0700 Subject: [PATCH] remove readme from docs --- docs/README.md | 31 ------------------------------- 1 file changed, 31 deletions(-) delete mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index ea26b9d..0000000 --- a/docs/README.md +++ /dev/null @@ -1,31 +0,0 @@ -# SSW.Dory Landing Page - -## Architecture Overview -![SSW Dory architecture diagram](./images/dory-website-architecture-diagram.webp) - -## Get Started - -### Install the project's dependencies: - -```bash -bun install -``` - -### Build the project: -```bash -bun run build -``` -Note - if an error comes up involving the [installation of the package sharp](https://github.com/lovell/sharp/issues/3511) while the next-image-export-optimizer is running, you'll need to postinstall sharp: -```bash -cd node_modules/sharp -bun install -``` - -### Run the project locally: - -```bash -bun run dev -``` - -## Local URLs -[http://localhost:8080/](http://localhost:8080/): browse the website