Skip to content

Commit

Permalink
Update readme with design considerations
Browse files Browse the repository at this point in the history
  • Loading branch information
kellpossible committed Sep 10, 2023
1 parent 28d6b00 commit a2e2ee5
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,22 @@

A simple self-hosted web server for creating and managing an avalanche forecast for a region, along with accepting public observations.

## Design Considerations

The following are goals that the project is striving to acheive (or has already achieved and needs to maintain) through careful decision making during the design process.

1. Contains all the basics needed to run an avalanche forecasting service website.
2. Reliable.
* Avalanche forecasts are an important public service.
* The only likely point of failure should be the host itself.
* Budget for on-call tech support is limited.
2. Simple and easy to install and operate from an administrative perspective.
* Avalanche professionals or enthusiasts are for the most part not necessarily professional server administrators or software engineers.
* From this perspective, the server is a single self-contained binary that is dead easy to install and run on any computer/web server.
* A docker container is also provided.
* The database is using [sqlite](https://www.sqlite.org/index.html), which is embedded into the application (no need for a separate service), and the data consists of a single file.
* Database backup and restore functionality is built into the application.

## Setup

```bash
Expand Down

0 comments on commit a2e2ee5

Please sign in to comment.