Home

Welcome to the typescript-boilerplate wiki!

Where is README.md? Even this boilerplate for quickstart projects, it is intended to keep your repository up-to-date by merging changes. Having documentation in the project route would cause unnecessary git conflicts.

Quick Setup

1. Create a new repository from this template.

   🔗LINK🔗

   Leave unticked 🔲 Include all branches.

2. Clone project on your local machine.

   Consider using GitHub CLI for easy authentication.

3. Open project folder in a terminal.

4. Download packages with your chosen tool.

   # Microsoft related...
   $ npm i
   
   # Facebook related...
   $ yarn

5. (Optional) Check 🚧 quickstart tutorial for recommended files to create.

6. (Optional) Keep your repository up-to-date:

   # Add remote repository
   $ git remote add boiler git@github.com:SubZtep/typescript-boilerplate.git
   
   # Update from boilerplate (should be a regular command)
   $ git pull boiler main -X theirs --allow-unrelated-histories

   Change boiler to anything you want.

7. (Optional) Happy coding!