mdnorman / node-roblox-ts-sapling

CHANGEME

Setup

Node

1. Install nvm (Node Version Manager)
2. cd to the project directory and execute the following:

   nvm install
   nvm use
   npm install
   

IDE Setup

This project uses EditorConfig for IDE configuration.

See .editorconfig for settings.

Many popular IDEs and editors support this out of the box or with a plugin.

Development

Prettier

This project uses Prettier, so please run it before checking in:

npm run pretty

See .prettierrc for settings.

Some IDEs and editors have plugins for running Prettier.

Linting

This project uses ESLint. Check linting before checking in:

npm run lint

See tslint.json for settings.

Many IDEs and editors support TSLint.

Testing

This project uses Jest for testing. Run tests before checking in.

npm test

Building

npm run build

Or, if you'd like to have it watch the files to build:

npm run build-watch

Syncing

This project depends on the [Rojo])https://rojo.space/docs/latest/) command line tool.

To run the server, do the following

npm rojos