Tinloof's Toolkit
Getting started
Installation
Start by installing the Remix CLI globally:
npm install @tinloof/remix-cli@latest -gTinloof packages are private and accessible only through an NPM token. Contact Tinloof to obtain one.
Once received, you can add the token in an .npmrc file in a parent directory that wraps your project.
Using the CLI
The tinloof-remix command has many options you can run:
$ tinloof-remix
? What do you want to do? (Use arrow keys)
❯ Start new project (new)
Create/update singletons (singletons)
Create new block (createBlock)
Create new document (createDocument)
Prune stale locales (deletes every document with an unsupported locale) (pruneLocales)
(Move up and down to reveal more choices)When running the CLI inside of a project, give preference to running npm run cli (or whatever script you have set-up for calling tinloof-remix). This will ensure you use the version of the CLI that is installed in your project's node_modules folder.
Updating the CLI
When starting a new project, always re-install @tinloof/remix-cli to make
sure it's up-to-date. You can check its version by running tinloof-remix -v.
Starting a project
Step-by-step guides to setting up new projects with the toolkit
File structure & architecture basics
Description of the high-level architecture of the toolkit
Creating new documents & route types
How to create new page types in the front-end and content model
Contributing
How to develop & ship the toolkit
Getting help & sharing feedback
We're active on Slack and Email and are eager to help. If you have any questions or suggestions, please reach out!