TiddlyWiki5/editions/multiwikidocs/tiddlers/Installation using Git.tid

title: Installation using Git
tags: Installation
modified: 20241105133737778
created: 20241105133737778

These instructions require basic knowledge both of the terminal and of Git. There are also [[alternative instructions without using Git|Installation]].

# Clone the code from GitHub with: <<.copy-code-to-clipboard "git clone -b multi-wiki-support --single-branch https://github.com/TiddlyWiki/TiddlyWiki5">>
# Open a terminal window and set the current directory to the root of the downloaded folder
# Install the dependencies with the command: <<.copy-code-to-clipboard "npm install">>
# Start the server with the command: <<.copy-code-to-clipboard "npm start">>
# To use MWS, visit http://localhost:8080 in a browser on the same computer
# When you have finished using MWS, stop the server with <kbd>ctrl-C</kbd>

See [[Troubleshooting]] if you encounter any errors.

To update your copy of MWS with newer changes from ~GitHub, run the following command:

<<.copy-code-to-clipboard "git pull">>
Docs: Copy content from tiddlywiki.com 2024-11-15 20:47:55 +00:00			`title: Installation using Git`
Docs: Add table of contents and custom palette 2024-11-16 12:35:04 +00:00			`tags: Installation`
Docs: Copy content from tiddlywiki.com 2024-11-15 20:47:55 +00:00			`modified: 20241105133737778`
			`created: 20241105133737778`

			`These instructions require basic knowledge both of the terminal and of Git. There are also [[alternative instructions without using Git\|Installation]].`

			`# Clone the code from GitHub with: <<.copy-code-to-clipboard "git clone -b multi-wiki-support --single-branch https://github.com/TiddlyWiki/TiddlyWiki5">>`
Add troubleshooting instructions 2024-11-18 12:25:07 +00:00			`# Open a terminal window and set the current directory to the root of the downloaded folder`
Docs: Copy content from tiddlywiki.com 2024-11-15 20:47:55 +00:00			`# Install the dependencies with the command: <<.copy-code-to-clipboard "npm install">>`
			`# Start the server with the command: <<.copy-code-to-clipboard "npm start">>`
			`# To use MWS, visit http://localhost:8080 in a browser on the same computer`
			`# When you have finished using MWS, stop the server with <kbd>ctrl-C</kbd>`

Add troubleshooting instructions 2024-11-18 12:25:07 +00:00			`See [[Troubleshooting]] if you encounter any errors.`

Docs: Copy content from tiddlywiki.com 2024-11-15 20:47:55 +00:00			`To update your copy of MWS with newer changes from ~GitHub, run the following command:`

			`<<.copy-code-to-clipboard "git pull">>`