TMF Map

Small steps get us to faraway places.

Table of Contents

• Prerequisites
• Installation
• Get Started
• Development
  • Format Document
  • Commit and PR TitleREADME.md
• Deployment
• Thanks

Prerequisites

Before installation, please make sure you have the right development environment:

• Node.js version >= 11.10.1 (you can use nvm to manage node.js)
• Install yarn (dependency management for node.js modules)

Installation

Run the below command to install dependencies:

yarn # or yarn install

Get Started

yarn 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.

Development

Format Document

All files (.md/.js) will be formatted automatically when commit changes. Please make sure you have installed all dependencies (yarn) otherwise the files won't be formatted automatically.

Commit and PR Title

You can commit as following pattern which is not required:

type(scope): description

But make sure the PR title follow above pattern and common types can be:

• add
• update
• fix
• build
• revert
• remove

For real world examples, please see commit logs.

Deployment

The website can be deployed automatically when master branch has been updated.

Thanks

• Docusaurus 2: a modern static website generator.
• Netlify: all-in-one platform for automating modern web projects.