Installation for development of flatlakeTools

flatlakeTools This is an experimental proof of concept set of tools for working with the FlatLake API generated by CloudCannon's Flat. The goal is to easily generate RSS 2.0 feeds from the JSON API as well as generated index blog page(s).

Quick install with curl or irm

There is an experimental installer.sh script that can be run with the following command to install latest table release. This may work for macOS, Linux and if you’re using Windows with the Unix subsystem. This would be run from your shell (e.g. Terminal on macOS).

curl https://caltechlibrary.github.io/flatlakeTools/installer.sh | sh

This will install the programs included in flatlakeTools in your $HOME/bin directory.

If you are running Windows 10 or 11 use the Powershell command below.

irm https://caltechlibrary.github.io/flatlakeTools/installer.ps1 | iex

If your are running macOS or Windows

You may get security warnings if you are using macOS or Windows. See the notes for the specific operating system you’re using to fix issues.

• INSTALL_NOTES_macOS.md
• INSTALL_NOTES_Windows.md

Installing from source

Required software

• Deno >= 2.4.3
• CMTools >= 0.0.37

Steps

1. git clone https://github.com/caltechlibrary/flatlakeTools
2. Change directory into the flatlakeTools directory
3. Make to build, test and install

git clone https://github.com/caltechlibrary/flatlakeTools
cd flatlakeTools
make
make test
make install