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 @@
+ Key Features • + How To Run Locally • + License +
+ +## 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 @@ + +