Skip to content

Commit

Permalink
docs: add README documentation for getting started (#9)
Browse files Browse the repository at this point in the history
## Description
Adds a README describing the planned features and how to develop locally

## Checklist
- [ ] I have tested my changes locally and they work as expected.
- [x] I have documented any new or modified functionality in the project
documentation.
- [ ] I have added appropriate comments to the code, especially in
complex or non-obvious sections.
- [ ] All existing tests pass successfully with my changes.
  • Loading branch information
j-chad authored Oct 1, 2023
2 parents be5d5b7 + 5113e5f commit b3e3449
Show file tree
Hide file tree
Showing 7 changed files with 93 additions and 30 deletions.
1 change: 1 addition & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions backend/Makefile
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions backend/README.md
Original file line number Diff line number Diff line change
@@ -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
```
10 changes: 0 additions & 10 deletions backend/taskfile.yml

This file was deleted.

12 changes: 12 additions & 0 deletions domus.iml
Original file line number Diff line number Diff line change
@@ -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>
32 changes: 13 additions & 19 deletions web/README.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down

0 comments on commit b3e3449

Please sign in to comment.