Fleet of the Faithful Knights (FFK) is a Star Citizen organisation that seeks to be a beacon of light in a dark universe.
This is the monorepo for the current codebase that is used within the administrative reigns of the org. As of now this consists of a working read and write API, Voting Panel and Onboarding service
Almost all the projects inside the repo will be written in/using a functional paradigm and as such you'll see usage of Option, Either, List, Set and Map data structures littered throughout the codebase.
I want to say that most of this stuff will just be plug and play but who knows, I might mess something up and break a thing or two.
| Name | Version |
|---|---|
| TypeScript | 5.x.x |
| Node | 22.x.x |
| Lerna | 8.0.0 |
| Esbuild | 19.x.x |
| Terraform | 1.0.0 |
| Docker | 24.x.x |
This ensures that you will be able to compile, build, run and deploy all projects in the repo.
Here's a one line install for all node packages. Do note that it is a global install.
npm i typescript lerna esbuild -g
These packages can be located at the default locations at either AppData/npm/node_modules on Windows machines
or usr/local/lib/node_modules on Linux.
Once you have installed the above, run lerna bootstrap from the root of the repository to 'bootstrap' or install
all dependencies for all projects in the repo.
For ease of use in terraform, also set up TF_VAR versions of these variables.
| Variable | Description |
|---|---|
| FFK_DATABASE_USERNAME | The database login username. |
| FFK_DATABASE_PASSWORD | The database login password. |
| FFK_DATABASE_NAME | The name of the database. |
| FFK_DATABASE_SERVER | The ip or dns that the database is stored on. |
| FFK_DATABASE_PORT | The port used to connect via UDP or TCP. |
| FFK_API_SERVER | The url for the API |
| FFK_DISCORD_CLIENT_SECRET | The discord bots client secret |
| FFK_DISCORD_BOT_TOKEN | The discord bots token |
| FFK_DISCORD_REDIRECT | A valid discord bot oauth2 redirect url |
| GH_TOKEN | A GitHub token with R/W package and registry permissions |
Debugging workflows can be a bit tedious if you don't know how to do it. Thankfully there are many open sourced tools out there that facilitate easy testing of workflows/GitHub Actions with minuscule differences to what is seen when you actually create a pull request with your code or have it pushed.
My personal favourite is https://github.com/nektos/act