README.md

DmxDocs

Demetrix FSharp coding documentation

Preface

This is a subset of the Demetrix devdocs. It was written for our internal use to help maintain consistency. If it happens to be useful for you, that's a happy coincidence, but no warranty implied, use at your own risk. Some of it specific to our conventions, but hopefully interesting. If you like it, let us know! If you want to improve it, please send in suggestions / additions / changes.

.Compsci

(Scientists who want to learn about computing concepts, start here!)

• I want to learn F#. What are some good resources? .fsharp
• Namespaces vs modules .backend .frontend .fsharp

.Standards

• AppContext and Dependency injection .backend
• How should I name branches and commits in Git? .git
• Usage of milestones in Git .git
• What is the Git package registry for api libraries .git .packages
• What code conventions do we use?
• What are our best practices for front-end development? .frontend
• I am creating a new app in the front-end, how should I structure it? .frontend
• What are our best practices for back-end development? .backend
• What are our best practices for database development? .database
• What are value objects and how should I use them? .backend .frontend
• Namespaces vs modules .backend .frontend
• Working with DateTime .backend .frontend .postgres

.Database

• How do I set Docker up for database development? .tools
• Storage functions best practices and antipatterns
• Working with the type provider: What issues might I run into? .postgres .backend
• Executing long-running queries

.Frontend

• What are our best practices for front-end development? .frontend
• I am creating a new app in the front-end, how should I structure it? .frontend