Code Monkey home page Code Monkey logo

typescripter's Introduction

TypeScript Starter Kit

This starter kit provides a basic setup for any TypeScript project with tsc (TypeScript compiler) and prettier (code formatter). It includes a sample package.json file to help you get started quickly.

How to use this starter kit?

  1. Clone this repository
git clone https://github.com/Okira-E/typescripter
  1. Install dependencies
npm install

Usage

Once the installation is complete, you can use the following npm scripts:

  • compile: Compiles the TypeScript code using tsc. The compiled JavaScript files will be generated in the ./build directory.
  • start: Runs the compiled JavaScript code using node. This script assumes the compiled files are in the ./build/src directory.
  • clean: Deletes the ./build directory and its contents.
  • format: Formats the TypeScript code using prettier. This script formats all .ts files in the src directory.

To execute a script, use the following command:

npm run <script-name>

Project Structure

The project structure assumes the following directory structure:

.
├── build/
├── node_modules/
├── src
│   └── main.ts
├── .prettierrc
├── package.json
└── tsconfig.json
  • The TypeScript source files should be placed in the src directory.
  • The compiled JavaScript files will be generated in the build directory.
  • The .prettierrc file contains the configuration for prettier.
  • The package.json file includes the project's metadata and scripts.
  • The tsconfig.json file contains the configuration for tsc.

Feel free to modify the project structure and configuration files as per your needs.

typescripter's People

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.