Getting Started

All the utilities associated with the Panfactum stack are contained in the stack git repository which is hosted by GitHub. This includes the local development environment, the infrastructure modules, and the documentation website. Making changes to the Panfactum stack means updating this repository.

Setting Up Developer Environment

1. Follow GitHub's instructions for forking the repository. If you plan on being a regular contributor, make sure you follow the instructions for syncing the fork with the upstream repo.

2. Follow the installation steps outlined in the Stack's getting started guide to ensure that you have the necessary utilities to launch the Stack's developer environment. You do NOT need to do any of the subsequent steps in that guide.

3. You will have the direnv allow the repo's .envrc file. Once you do this, all the stack's development utilities should be automatically installed, and you are ready to begin development.

Understanding Project Setup

The project is broken into "packages" which can be found under the packages directory.

We currently have the following packages:

• nix: Contains BOTH the local development environment for users of the Panfactum stack (under mkDevShells) AND for developers of the panfactum stack (under devenv)

• infrastructure: Contains all the infrastructure-as-code modules that comprise the Panfactum stack

• website: Contains the source code for this website

• reference: Contains a complete deployment of the Panfactum stack that developers can use as a reference point for their own organization

• eslint: Contains shared linting rules for all our Typescript / Javascript projects

Next Steps

• Open a pull request