Skip to content

Latest commit

 

History

History
56 lines (45 loc) · 1.23 KB

README.md

File metadata and controls

56 lines (45 loc) · 1.23 KB
Raw

canvas-starter

This is a simple project that is meant to be a simple starting point for basic canvas websites. I am mostly using it for my own personal projects, but it may be useful to you if:

  • You only intend to have one page (index.html)
  • You like TypeScript
  • You want something as simple as possible
  • You want to get started quickly

Usage

Clone the repository:

# Using HTTPS
git clone --depth=1 https://github.com/devmattrick/canvas-starter.git <name>

# Or using SSH
git clone --depth=1 [email protected]:devmattrick/canvas-starter.git <name>

Install dependencies:

# Using Yarn
yarn

# Or using NPM
npm install

Run the development server:

# Using Yarn
yarn run dev

# Or using NPM
npm run dev

Build an optimized production bundle:

# Using Yarn
yarn run build

# Or using NPM
npm run build

Contributing

Contributions are always welcome, however please try to keep the general scope of this project small (for example, don't include a canvas library like Phaser). This is meant to be a simple base to build off of and as such is library/ framework/ etc. agnostic.

License

The code in this repository is available under the terms of the MIT License. Please see LICENSE for more information.