Skip to content

trackmage/documentation

Repository files navigation

Trackmage - A tracking page for your store. Beautiful, branded, customizable.

TrackMage Documentation

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ npm install

Local Development

$ npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build

$ npm run build

Download json files

wget https://api.trackmage.com/docs.json -O ./src/swagger_docs.json
wget https://api.trackmage.com/public/carriers --header="accept: application/json"  -O ./src/carriers.json

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

$ GIT_USER=karser USE_SSH=true npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.