jfluhler/act

Offline-first web and mobile app for goal setting, achievement tracking, and getting things done

The Act App

General purpose, offline first web and mobile applications for goal setting, achievement tracking, and getting things done. Reimagining of Points

Technical overview

This repository is an exploratory exercise and case study of three concepts: offline first mobile applications, code sharing via monorepos (using Nx), and microservices. The foremost technical goals of The Act App are to investigate these concepts, determine best practices, and apply them to a real-world idea.

Applications, libraries, and architecture

/apps/api

• This application is the layer between web/mobile and the CouchDB instance. In adherence with the offline first ideology, the primary responsibility of this application is to sync data between clients and the CouchDB instance.
• Primary tools
  • NestJS (TypeScript)
  • CouchDB

/apps/mobile

• This application is the Android and iOS mobile applications in a single codebase. This is the main client facing consumer of the api application. Offline-first ideology dictates the need to maintain a database of information on the user's device and the ability to sync and persist any information to the api application.
• Primary tools
  • ReScript (rescript-react)
  • React Native (rescript-react-native)
  • React Native Paper (rescript-react-native-paper)
  • React Navigation (rescript-react-navigation)
  • WatermelonDB (SQLite)

/apps/web

• This application is (currently) an administration portal to view tabular data affected by the client. Determining cross cutting concerns between mobile and web facilitates the discovery of code-sharing best practices.
• Primary tools
  • React (TypeScript)
  • Material UI
  • WatermelonDB (LokiDB)

/libs/data/core

• This library brings the entirety of data/schema construction and maintenance to the frontend. The api application simply takes what this library constructs and organizes it as documents in CouchDB. This project also contains utilites for getting and observing data as it moves through the web and mobile applications.
• Primary tools
  • TypeScript
  • TSyringe
  • WatermelonDB

/libs/data/rn & /libs/data/web

• These two libraries handle the diverging data configurations of the web and mobile applications. Not everything can or should be shared with both applications.
• Primary tools
  • TypeScript
• Mobile tools
  • Keycloak as an OIDC provider (@react-keycloak/native)

docker-compose.yml

• This file is for managing the required services to run The Act App.
• Services
  • CouchDB
  • Keycloak
  • PostgreSQL