https://github.com/sinedied/codingame-ts-starter

:muscle: Typescript starter template for CodinGame challenges
https://github.com/sinedied/codingame-ts-starter

challenges codingame jest parcel prettier starter template typescript

Last synced: 3 months ago
JSON representation

:muscle: Typescript starter template for CodinGame challenges

• Host: GitHub
• URL: https://github.com/sinedied/codingame-ts-starter
• Owner: sinedied
• Created: 2018-08-02T12:42:40.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-01-11T13:46:11.000Z (about 4 years ago)
• Last Synced: 2024-10-04T16:25:18.501Z (4 months ago)
• Topics: challenges, codingame, jest, parcel, prettier, starter, template, typescript
• Language: TypeScript
• Homepage:
• Size: 83 KB
• Stars: 12
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# :muscle: codingame-ts-starter

> Typescript starter template for CodinGame challenges

**Features**

- [TypeScript](https://www.typescriptlang.org)

- Module bundling and minification with [Parcel](https://parceljs.org)

- Testing with [Jest](https://jestjs.io)

- Code formatting with [Prettier](https://prettier.io)

- [VSCode](https://code.visualstudio.com/?WT.mc_id=javascript-0000-yolasors) integrations

## Installation

1. `git clone` this repo

2. Run `npm install` in the project folder

You also need [CodinGame Sync](https://www.codingame.com/blog/new-feature-codingame-sync-use-your-own-code-editor-on-codingame/) to synchronize your local code with the CodinGame editor.

## Usage

Run either `npm start` or `npm run build` to generate the output file, then start the CodinGame Sync tool and choose to sync the `dist/index.js` file.

### Commands

- `npm start`: build your code in watch mode (it will automatically recompile on change).

  Note that in this mode code size optimizations are NOT performed, use `npm run build` for that.

- `npm run build`: build your code once, with tree-shaking and minification

- `npm run test`: run unit tests once

- `npm run test:watch`: run unit tests in watch mode

- `npm run prettify`: reformat all your code automatically

### VSCode integrations

All NPM scripts are mapped to VSCode tasks, and the build shortcut is mapped to the `npm run build` command.

A launch configuration is also ready-to-use to debug your tests with breakpoints support within VSCode.