Getting Started

Prerequisites

1. Install Node.js (LTS)
2. Install Simple Web Server (or another web server for local development purposes only)

Download

Download the latest version of Teddy from Teddy's GitHub releases page, and extract the contents of the archive file into a folder of your choice. The location of this folder will hereafter be referred to as $TEDDY_BASE.

Setup

Open your command line application (Command Prompt in Windows or the Terminal in Linux), navigate to $TEDDY_BASE and execute the following command to download the JavaScript package dependencies that Teddy requires to build static sites.

npm install

Build

Teddy comes pre-bundled with demo site content, for a demo travel blog called travelbook, and a default template named bear. To build a static site locally, execute the following command. Note that this command will only build the static site. It will not deploy it to the internet.

npm run build -- --site-name travelbook --theme-name bear

The static site will be built in $TEDDY_BASE/sites/{site.name}/public/{env}, where site.name is the name of the site, for example travelbook, and env is the environment name that is set to local by default.

Test

To view your static website for local development purposes, configure a locally installed web server to serve the files found in $TEDDY_BASE/sites/{site.name}/public/{env}. For local development purposes only, we recommend using Simple Web Server.

1. Open Simple Web Server.
2. Select 'New Server'.
3. In 'Folder path' navigate to and select $TEDDY_BASE/sites/{site.name}/public/{env} (for example $TEDDY_BASE/sites/travelbook/public/local).
4. Select a port number (8080 by default).
5. Under 'Basic Options', check the 'Automatically show index.html' option.
6. Select 'Create Server'.
7. Run the newly created server.

In your internet browser, navigate to http://localhost:8080 to view your static website.

Next Steps

Read the installation guide for detailed installation instructions including a walkthrough of the Teddy directory structure.