Jet
BuyFollow on X
  • Home
  • Satisfied Requirements
  • License
  • Architecture
    • Overview
    • Internal Dependency Graph
    • External Dependencies
    • Conventions
  • Recipes
    • Get Started
    • Add a Page
    • Customise Fonts
    • Customise Icons
    • Customise Languages
    • Customise Themes
    • Add an Environment Variable
  • Classes
    • Jet Mat Paginator Intl
    • Transloco HTTP Loader
  • Components
    • App Component
    • Footer Component
    • Home Page Component
    • Message Page Component
    • Not Found Page Component
    • Page Component
    • Profile Page Component
    • Reset Password Page Component
    • Settings Page Component
    • Sign In Page Component
    • Sign Out Page Component
    • Sign Up Page Component
    • Update Password Page Component
  • Constants
    • Color Scheme Options
    • Default Color Scheme Option
    • Default Language Option
    • Default Settings
    • Language Options
    • Navigation Menu Items
  • Directives
    • Analytics Directive
  • Enums
    • Bucket
    • LocalStorage Key
    • Query Param
    • SessionStorage Key
    • Table
  • Guards
    • Is Authenticated
    • Is Not Authenticated
  • Interfaces
    • Color Scheme Option
    • Language Option
    • Navigation Menu Item
    • Profile
    • Progress Bar Configuration
    • Settings
  • Services
    • Alert Service
    • Analytics Service
    • Logger Service
    • Profile Service
    • Progress Bar Service
    • Service Worker Service
    • Settings Service
    • Storage Service
    • Supabase Service
    • Toolbar Title Service
    • User Service
  • Types
    • Available Color Scheme
    • Available Font
    • Available Language
    • Available OAuth Provider
Powered by GitBook
On this page
  • Prerequisites
  • Start Building
  • Optional: Optimize and Personalize Further

Was this helpful?

  1. Recipes

Get Started

PreviousConventionsNextAdd a Page

Last updated 2 months ago

Was this helpful?

Jet is a that you can use to under your, or your organization's GitHub account.

Prerequisites

  1. You have a GitHub account and are logged in.

  2. You have bought access to Jet. If not, .

  3. You have been granted access to Jet and can access . If not, or instead.

Start Building

Step 1: Open .

Step 2: Click Use this template, then click Create a new repository.

Step 4: Click Create repository. You will now have a repository with Jet as the initial commit.

Alternatively, if you choose to not use this feature, you can ignore creating the token and the Actions secret, and remove the workflow file altogether.

Step 5: Clone the repository and do the following:

  1. Delete .github/FUNDING.yml to remove Jet's sponsorship links.

  2. Delete CHANGELOG.md. A new one will be created automatically when Release Please Action runs next.

  3. Duplicate .env.example and rename it to .env for local environment variables. It has already been added to .gitignore and won't be committed.

  4. Empty the template of Footer Component.

  5. Use the configuration in vercel.json as a reference for your hosting configuration; delete it afterwards.

  6. Reset version in package.json to "0.0.0".

  7. Run npm i to install dependencies and enable Husky. It will also update the version property in package-lock.json to "0.0.0".

  8. Run npm run commit to commit these changes.

  9. Start building!

Optional: Optimize and Personalize Further

  1. Update the title, keywords and description tags in index.html.

  2. Update this._prefix in Storage Service to a unique string, so keys of other apps made with Jet do not conflict on localhost.

  3. Update scope-enum in .commitlintrc.json with major features of your app so changes of a feature are grouped together in CHANGELOG.md.

  4. Integrate with an analytics service. Update the Content Security Policy rules in index.html accordingly.

  5. Set up Supabase Redirect URLs (suffix * to forward query params) and OAuth providers.

Step 3: Choose the Owner, Repository name and Description (optional). Select Private since prohibits sharing it publicly.

Optional: Since a token isn't set, will run and fail (it runs on pushes to the main branch). This is normal and expected.

You can and add it to your repository's Actions secrets. Name it RELEASE_PLEASE_TOKEN as mentioned in the workflow file (.github/workflows/release-please.yml). Click Add secret.

and set the Supabase key and URL in .env. Set the URL in index.html and your Content Security Policy.

Replace Jet icons and logo with your own in public/. is a great tool to generate icons from a single icon file.

Compress images if any. is a great tool to convert images to modern formats.

Update sitemap-main.xml to include all routes of your app. Submit it to various crawlers (, , , etc.) when your app is ready. Update robots.txt if required.

Jet's license
Release Please Action
create a token
Set up a new Supabase project
https://realfavicongenerator.net/
https://squoosh.app/
Bing
Google
Yandex
template repository
create your own repository
buy
https://github.com/karmasakshi/jet
DM us on X
send the author an email
https://github.com/karmasakshi/jet
Create a new repository from template
Create a new repository from template
Choose Private
Choose Private
Jet as the initial commit
Jet as the initial commit
Actions secrets
Actions secrets
Supabase Redirect URLs
Supabase Redirect URLs
Release Please Action fails without token
fails without token
Release Please Action