@rootreeweb/quick-start

What is This?

@rootreeweb/quick-start provides scaffolding for new JavaScript projects.

Getting Started

1. The first step (if you haven't done so already) is to setup authentication for using our private packages. You can find instructions for doing that within the Rootree Web Wiki. You only need to create a token and set it in your environment.

2. Pick your template. Currently the available templates are:

   • Basic
   • Publishable
   • React

3. Create a directory for your project and open a terminal there.

4. Run the following script. Add the name of the template (if not basic) at the end of the last line.

   touch .yarnrc.yml
   yarn init
   yarn config set nodeLinker node-modules
   yarn config set npmScopes.rootreeweb.npmRegistryServer "https://npm.pkg.github.com"
   yarn config set npmScopes.rootreeweb.npmAlwaysAuth true
   yarn config set npmScopes.rootreeweb.npmAuthToken "\${GHACCESS}"
   yarn config unset yarnPath
   yarn dlx -p @rootreeweb/quick-start "make-project"

Examples

Basic

touch .yarnrc.yml
yarn init
yarn config set nodeLinker node-modules
yarn config set npmScopes.rootreeweb.npmRegistryServer "https://npm.pkg.github.com"
yarn config set npmScopes.rootreeweb.npmAlwaysAuth true
yarn config set npmScopes.rootreeweb.npmAuthToken "\${GHACCESS}"
yarn config unset yarnPath
yarn dlx -p @rootreeweb/quick-start "make-project"

Package

touch .yarnrc.yml
yarn init
yarn config set nodeLinker node-modules
yarn config set npmScopes.rootreeweb.npmRegistryServer "https://npm.pkg.github.com"
yarn config set npmScopes.rootreeweb.npmAlwaysAuth true
yarn config set npmScopes.rootreeweb.npmAuthToken "\${GHACCESS}"
yarn config unset yarnPath
yarn dlx -p @rootreeweb/quick-start "make-project" publishable

React (With Tailwind CSS)

touch .yarnrc.yml
yarn init
yarn config set nodeLinker node-modules
yarn config set npmScopes.rootreeweb.npmRegistryServer "https://npm.pkg.github.com"
yarn config set npmScopes.rootreeweb.npmAlwaysAuth true
yarn config set npmScopes.rootreeweb.npmAuthToken "\${GHACCESS}"
yarn config unset yarnPath
yarn dlx -p @rootreeweb/quick-start "make-project" react

React Package (With Tailwind CSS)

touch .yarnrc.yml
yarn init
yarn config set nodeLinker node-modules
yarn config set npmScopes.rootreeweb.npmRegistryServer "https://npm.pkg.github.com"
yarn config set npmScopes.rootreeweb.npmAlwaysAuth true
yarn config set npmScopes.rootreeweb.npmAuthToken "\${GHACCESS}"
yarn config unset yarnPath
yarn dlx -p @rootreeweb/quick-start "make-project" reactPublishable