What you end up with
OpenTEX running in your browser, on your own computer. It is free, and it stays free. It opens with Sign in with publik; no trial, no subscription.
- Time
- About 34 minutes
- Steps
- 15
- Cost
- Free
Before you start
These are one-time installs. If you have used PowerShell before, you may have them already — the first step checks.
Install Git
Run the installer, then reopen PowerShell.
Open installerYou know this worked when: Git responds with a version number
Install Node LTS
Run the LTS installer, then reopen PowerShell.
Open downloadYou know this worked when: Node responds with a version number
Install OpenTEX
Open PowerShell
Keep it open beside this page.
You know this worked when: PowerShell is open
Check Git and Node
Git and the current Node LTS are required.
Type this into PowerShell (not Command Prompt), then press Enter.
git --version node --versionYou know this worked when: Git and Node respond with version numbers
Copy OpenTEX to this PC
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~ if [ ! -d OpenTEX/.git ]; then git clone https://github.com/shaurya202/OpenTEX.git fiYou know this worked when: A OpenTEX folder appears
Open the OpenTEX folder
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~ cd OpenTEXYou know this worked when: Your terminal prompt is inside the OpenTEX folder
Use the reviewed version
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/OpenTEX git checkout 8ef41a8d99a9e515ed92663958c48d4cbdba847fYou know this worked when: Git reports the reviewed commit
Install dependencies
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/OpenTEX npm.cmd installYou know this worked when: The command finishes without an error
Get a PUBLIK_API_KEY key
Sign in, create a key, and copy it.
Open the pageYou know this worked when: You have a key on your clipboard
Copy the env file
Then open .env and set PUBLIK_API_KEY.
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/OpenTEX Copy-Item .env.example .envYou know this worked when: .env has PUBLIK_API_KEY set
Get a PUBLIK_APP_TOKEN key
Sign in, create a key, and copy it.
Open the pageYou know this worked when: You have a key on your clipboard
Copy the env file
Then open .env and set PUBLIK_APP_TOKEN.
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/OpenTEX Copy-Item .env.example .envYou know this worked when: .env has PUBLIK_APP_TOKEN set
Run OpenTEX
Keep PowerShell open.
Type this into PowerShell (not Command Prompt), then press Enter. The first line moves you into the folder this step runs in, so it works in a window you have just opened.
cd ~/OpenTEX npm.cmd run devYou know this worked when: localhost:3000 responds
Open it in your browser
If a different port was picked, open that one instead.
Open localhost:3000You know this worked when: The app loads in the browser
Try it
OpenTEX should be open in your browser.
You know this worked when: OpenTEX works
If something goes wrong
Nothing here can damage your computer, and every step can be run again safely. If a command fails, the usual cause is the step before it not having finished.
Still stuck? Tell us what happened and we will fix the guide. Include the step number and we can usually reproduce it.