emperorhan / typescript-template

PROJECT_NAME

typescript template

project_description
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgements

About The Project

![Product Name Screen Shot][product-screenshot]

Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: github_username, repo_name, twitter_handle, email, project_title, project_description

Built With

• nodejs : Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine.

• typescript : TypeScript is JavaScript with syntax for types.

• jest : Jest is a delightful JavaScript Testing Framework with a focus on simplicity.

• eslint : Find and fix problems in your JavaScript code.

• prettier : An opinionated code formatter.

• husky : Modern native git hooks made easy.

• lint-staged : simple to use tool to enforce code quality in teams.

• standard-version : A utility for versioning using semver and CHANGELOG generation powered by Conventional Commits.

• commitlint : commitlint helps your team adhering to a commit convention.

• commitizen : Its main purpose is to define a standard way of committing rules and communicating it (using the cli provided by commitizen).

• typedi : TypeDI is a dependency injection library for TypeScript and JavaScript.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

• yarn

  yarn install yarn@latest -g

Installation

1. Clone the repo

   git clone https://github.com/emperorhan/typescript-template.git

2. Install packages

   npm install

   or

   yarn install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Add your Changes (git add changedThing)
4. Commit your Changes (yarn cz)
5. Push to the Branch (git push origin feature/AmazingFeature)
6. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @github - email

Project Link: https://github.com/emperorhan/typescript-template

Acknowledgements

• DDD

• EEE

• FFF