By running the static self-host version, you can use Typing Mind from your private server or from a local device.
GitHub Repo: https://github.com/TypingMind/typingmind
Option 1: Deploy TypingMind on your server
To run the app locally on your device or private server:
- Clone the repo
- Install dependencies:
yarn installornpm install
- Start the server:
yarn startornpm run start
- App will run at
localhost:3000by default.
- To update the app, simply
git pulland restart your server.
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:
- Fork the GitHub repo
- Log into Netlify
- Locate the “Sites” section
- Click on Add New site > choose Import an existing project
- Choose Deploy with GitHub
- Choose the TypingMind project that you forked in Step 1.
- Enter the Site name then scroll down to locate the “Publish directory” section, enter “src”
- Click on “Deploy” to deploy TypingMind on Netlify
- 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.
Important note
- 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.
- You are unable to change the branding name and customize the UI.
- The static self-host version updates are delayed from 1 or 2 versions compared to the latest versions on www.typingmind.com