Collabs App Template

Template for a basic Collabs app.

Our Quick Start walks through using this template.

Collabs Docs

Installation

First, install Node.js. Then run npm i.

Commands

npm start

Runs both servers for testing for the app:

• webpack-dev-server on port 3000, to serve static files.
• collabs-ws-server on port 3001, to connect users via aWebSocket server.

Open http://localhost:3000/ to try it out. Use multiple browser windows at once to test collaboration.

You can run the servers separately with npm run start:webpack and npm run start:ws-server.

npm run dev

Build the app from src/, in development mode.

webpack-dev-server will build for you, so you do not need to do this until you start serving files yourself.

npm run build

Build the app from src/, in production mode.

webpack-dev-server will build for you, so you do not need to do this until you start serving files yourself.

npm run clean

Delete dist/.

Starter Files

• Code:
  • src/index.html: The app's HTML.
  • src/main.ts: The app's TypeScript code.
• Configuration:
  • package.json: npm install file.
  • tsconfig.json: TypeScript configuration for the app.
  • webpack.config.ts: Wepback configuration.
  • tsconfig.webpack-config.json: TypeScript configuration that lets us write webpack.config.ts in TypeScript instead of JavaScript.