Merge branch 'update-misc-docs-202408281256' into 'main'

chore: update misc docs

See merge request flattrack/flattrack!401

README.md

@@ -22,6 +22,7 @@
 
 ### Future
 
+-   Costs
 -   Tasks
 -   Noticeboard
 -   Shared Calendar
@@ -68,7 +69,7 @@ Please read:
 
 ## License
 
-Copyright 2019-2023 Caleb Woodbine.
+Copyright 2019-2024 Caleb Woodbine.
 This project is licensed under the [AGPL-3.0](http://www.gnu.org/licenses/agpl-3.0.html) and is [Free Software](https://www.gnu.org/philosophy/free-sw.en.html).
 This program comes with absolutely no warranty.
 

docs/design-guidelines.md

@@ -1,4 +1,3 @@
-
 # Design guidelines
 
 How FlatTrack must be built.
@@ -14,22 +13,21 @@ The project must be:
 -   useful: the features provided should be exactly what people need
 -   reliable: it must be built for strong-reliablity
 -   secure: it must be secure by default; there must be large security focus
--   private: it must not communicate with third-parties for app resources and functions (exception of things like authentication via OAuth); information in the attached database must not leave where it resides
+-   private: it must not communicate with third-parties for app resources and functions (exception for optional things like authentication via OAuth); information in the attached database must not leave where it resides
 -   accessible: there must be many ways to run it or get an instance
 -   portable: it must be easy to pick up an instance and take it somewhere else
 -   conformant: no matter where it runs, it should be expected to be the same
 -   tested: it should be well-tested and audited for quality and consistency
--   using open standards:
 
 
 ## API
 
 The API must be:
 
--   stateless: it doesn’t have any moving parts; nothing is stored in memory which is unique to the instance - so it can scale
+-   stateless: it doesn't have any moving parts; nothing is stored in memory which is unique to the instance - so it can scale
 -   dependency: it should live out of the database
 -   performant: it must be built to be fast
--   declarative: all resources (accounts, shopping lists, etc…) must read and write mostly the same data (expect credentials and secrets)
+-   declarative: all resources (accounts, shopping lists, etc...) must read and write mostly the same data (expect credentials and secrets)
 -   structured: it must respond and accept JSON data
 -   split up into packages: each feature or area of FlatTrack must be split up in package for easy reuse and testing
 

docs/development.md

@@ -12,6 +12,20 @@ Requirements:
 brew bundle install --file ./hack/Brewfile
 ```
 
+
+## Write an environment file
+
+Write the credientials for the database into `.env`
+
+    APP_DB_USERNAME=flattrack
+    APP_DB_PASSWORD=flattrack
+    APP_DB_DATABASE=flattrack
+    APP_DB_HOST=localhost
+
+
+see the `example.env` file in the root of the repo for more.
+
+
 ## Launch a workspace with Zellij
 
 launch the workspace
@@ -20,6 +34,7 @@ launch the workspace
 ./hack/start-dev.sh
 ```
 
+
 ## Set up Postgres
 
 Docker/Podman:
@@ -61,16 +76,6 @@ Build the backend
     ./hack/verify-build-smoketest.sh
 
 
-## Write an environment file
-
-Write the credientials for the database into `.env`
-
-    APP_DB_USERNAME=flattrack
-    APP_DB_PASSWORD=flattrack
-    APP_DB_DATABASE=flattrack
-    APP_DB_HOST=localhost
-
-
 ### Start the backend
 
     go run .

example.env

@@ -3,7 +3,7 @@ APP_DB_PASSWORD=flattrack
 APP_DB_DATABASE=flattrack
 APP_DB_HOST=localhost
 
-APP_DIST_FOLDER=./kodata/web
+APP_WEB_FOLDER=./kodata/web
 APP_URL=http://localhost:8080
 
 APP_METRICS_ENABLED=false