From 5113e5f978fed98bde0d448490c8b1a98ca98967 Mon Sep 17 00:00:00 2001
From: Jackson Chadfield <contact@jacksonc.dev>
Date: Sun, 1 Oct 2023 13:06:47 +1300
Subject: [PATCH] add documentation

---
 .idea/modules.xml    |  1 +
 README.md            | 39 ++++++++++++++++++++++++++++++++++++++-
 backend/Makefile     |  8 ++++++++
 backend/README.md    | 21 +++++++++++++++++++++
 backend/taskfile.yml | 10 ----------
 domus.iml            | 12 ++++++++++++
 web/README.md        | 32 +++++++++++++-------------------
 7 files changed, 93 insertions(+), 30 deletions(-)
 create mode 100644 backend/Makefile
 create mode 100644 backend/README.md
 delete mode 100644 backend/taskfile.yml
 create mode 100644 domus.iml

diff --git a/.idea/modules.xml b/.idea/modules.xml
index ae6dde3..6e623e5 100644
--- a/.idea/modules.xml
+++ b/.idea/modules.xml
@@ -3,6 +3,7 @@
   <component name="ProjectModuleManager">
     <modules>
       <module fileurl="file://$PROJECT_DIR$/backend/backend.iml" filepath="$PROJECT_DIR$/backend/backend.iml" />
+      <module fileurl="file://$PROJECT_DIR$/domus.iml" filepath="$PROJECT_DIR$/domus.iml" />
       <module fileurl="file://$PROJECT_DIR$/web/web.iml" filepath="$PROJECT_DIR$/web/web.iml" />
     </modules>
   </component>
diff --git a/README.md b/README.md
index 133b87f..dd291c1 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,38 @@
-# domus
+
+<h1 align="center">
+  Domus
+  <br>
+</h1>
+
+<h4 align="center">An open-source flat management system for students</h4>
+
+> [!WARNING]  
+> This project is still in development and is not ready for production use.
+
+<p align="center">
+  <a href="#key-features">Key Features</a> •
+  <a href="#how-to-run-locally">How To Run Locally</a> •
+  <a href="#license">License</a>
+</p>
+
+## Key Features
+
+- [ ] Chore Management
+- [ ] Bill Management
+- [ ] Shopping List
+- [ ] Calendar
+- [ ] Chat
+- [ ] User Management
+- [ ] Shared Documents
+
+## How To Run Locally
+
+```bash
+$ git clone https://github.com/j-chad/domus
+```
+
+Follow the instructions in the [backend](backend/README.md) and [frontend](frontend/README.md) READMEs.
+
+## License
+
+MIT
diff --git a/backend/Makefile b/backend/Makefile
new file mode 100644
index 0000000..52085af
--- /dev/null
+++ b/backend/Makefile
@@ -0,0 +1,8 @@
+setup:
+	cargo run --bin setup-local-config
+
+docker-deps:
+	docker-compose up -d
+
+start: docker-deps
+	env DOMUS_ENV='dev' cargo run --bin domus
\ No newline at end of file
diff --git a/backend/README.md b/backend/README.md
new file mode 100644
index 0000000..9fd2a44
--- /dev/null
+++ b/backend/README.md
@@ -0,0 +1,21 @@
+# Domus Backend
+
+Rust backend powering the [Domus flat management system](../README.md).
+
+## Getting Started
+
+These instructions will give you a copy of the project up and running on
+your local machine for development and testing purposes.
+
+### Prerequisites
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Docker](https://docs.docker.com/get-docker/)
+
+### Installing
+```bash
+# Prepare the local environment
+make setup
+
+# Run the server
+make start
+```
diff --git a/backend/taskfile.yml b/backend/taskfile.yml
deleted file mode 100644
index 056c9b7..0000000
--- a/backend/taskfile.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-version: 3
-
-tasks:
-  local-env:
-    cmds:
-      - cargo run --bin setup-local-config
-
-  setup-infra:
-    cmds:
-      - docker-compose up -d
\ No newline at end of file
diff --git a/domus.iml b/domus.iml
new file mode 100644
index 0000000..7fff58f
--- /dev/null
+++ b/domus.iml
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="JAVA_MODULE" version="4">
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="SonarLintModuleSettings">
+    <option name="uniqueId" value="5a563dc5-d4f5-4fe7-9440-252a44d56d57" />
+  </component>
+</module>
\ No newline at end of file
diff --git a/web/README.md b/web/README.md
index a7b0032..87737f7 100644
--- a/web/README.md
+++ b/web/README.md
@@ -1,31 +1,25 @@
-# create-svelte
+# Domus Web Frontend
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+Svelte frontend for the [Domus flat management system](../README.md).
 
-## Creating a project
+## Getting Started
 
-If you're seeing this, you've probably already done this step. Congrats!
+These instructions will give you a copy of the project up and running on
+your local machine for development and testing purposes.
 
-```bash
-# create a new project in the current directory
-bun create svelte@latest
-
-# create a new project in my-app
-bun create svelte@latest my-app
-```
-
-## Developing
-
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+### Prerequisites
+- [Bun](https://bun.sh/)
 
+### Developing
 ```bash
-bun run dev
+# Install dependencies
+bun install
 
-# or start the server and open the app in a new browser tab
-bun run dev -- --open
+# Run the server
+bun run dev
 ```
 
-## Building
+### Building
 
 To create a production version of your app: