How to set up static self-host

By running the static self-host version, you can use Typing Mind from your private server or from a local device.
Image without caption

Option 1: Deploy TypingMind on your server

To run the app locally on your device or private server:
  1. Clone the repo
  1. Install dependencies:Β yarn installΒ orΒ npm install
  1. Start the server:Β yarn startΒ orΒ npm run start
  1. App will run atΒ localhost:3000Β by default.
  1. To update the app, simplyΒ git pullΒ and restart your server.
Image without caption
Note: if you run the app on hostnames other thanΒ localhost, you must use HTTPS to make sure all app features work.

Option 2: Deploy TypingMind on a static web cloud service

You can upload to any static web hosting such as Netlify, Vercel, GitHub Pages, Cloudflare Pages, AWS S3, etc. to host the files.
Here’s the detailed guidelines of deploying the app on Netlify:
  1. Fork the GitHub repo
Image without caption
  1. Log into Netlify
  1. Locate the β€œSites” section
  1. Click on Add New site > choose Import an existing project
Image without caption
  1. Choose Deploy with GitHub
Image without caption
  1. Choose the TypingMind project that you forked in Step 1.
Image without caption
  1. Enter the Site name then scroll down to locate the β€œPublish directory” section, enter β€œsrc”
Image without caption
  1. Click on β€œDeploy” to deploy TypingMind on Netlify
  1. To update the app, go to your forked repo on GitHub and click on β€œSync fork”, it will automatically sync the app with the latest update to your TypingMind site on Netlify.
Image without caption

Important note

  1. You must deploy the app at the root level of your domain or subdomain. Deploying under a subfolder will not work. For example:Β https://yourdomain.com/Β will work,Β https://chat.yourdomain.com/Β will work,Β but https://yourdomain.com/typingmind/Β will not work.
  1. You are unable to change the branding name and customize the UI.
  1. The static self-host version updates are delayed from 1 or 2 versions compared to the latest versions onΒ www.typingmind.com