Project | Description | Build tool | Quality |
---|---|---|---|
blikk | Embeddable beginner-friendly language with static types, fast compilation | Felix | WIP |
core | Base C++ libraries (such as libcc) and small wrappers (R, rapidjson...) | Felix | Good |
cnoke | Simple alternative to cmake.js, without any dependency | Node.js | Good |
drd | Alternative PMSI MCO classifier, subprojects: libdrd, drdc and drdR | Felix/R | Good |
felix | Small build system made specifically for this repository | Felix | Good |
goupile | Programmable electronic data capture application | Felix | WIP |
heimdall | Medical timeline visualization (proof-of-concept) | Felix/R | POC |
koffi | Fast and simple C FFI (foreign function interface) for Node.js | Node.js | Good |
rekord | Public-key backup tool with deduplication | Felix | WIP |
thop | Web-based institutional PMSI (MCO) reporting tool based on libdrd | Felix | Good |
web | Reusable utility functions and HTML/CSS/JS widgets | Felix | Good |
webler | Simple markdown-to-HTML website generator (e.g. koromix.dev) | Felix | Good |
Most projects use a dedicated build tool called felix. To get started, you need to build this tool. You can use the bootstrap scripts at the root of the repository to bootstrap it:
- Run
./bootstrap.sh
on Linux and macOS - Run
bootstrap.bat
on Windows
This will create a felix binary at the root of the source tree. You can then start it to
build all projects defined in FelixBuild.ini: felix
on Windows or ./felix
on Linux and macOS.
The following compilers are supported: GCC, Clang and MSVC (on Windows). If you want to build Fast or LTO builds you also need to install Node.js in order to transpile the JS code used in some projects.
Use ./felix --help
for more information.
As of now, R packages cannot be built using this method.
Refer to each project (Koffi, etc.) documentation for instructions on how to build these projects.
Some packages provide an Rproject file and can be built by R CMD INSTALL. Open the project file (e.g. src/drd/drdR/drdR.Rproj) in RStudio and use Install and restart in the Build tab.
Provided the needed dependencies are available (including Rtools and Rcpp), it should just work!
I've started using a single repository for all my projects in 2018 because it is easier to manage. There are two killers features for me:
- Cross-project refactoring
- Simplified dependency management
You can find a more detailed rationale here: https://danluu.com/monorepo/