Git Product home page Git Product logo

ts-boilerplate's Introduction

TypeScript Project Template

This repository serves as a template for TypeScript projects, providing a basic setup with Jest for unit testing, Prettier for code formatting, and ESLint for linting.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • Node.js (v14 or newer recommended)
  • Yarn

Installation

1. Clone the repository & Install:

git clone https://github.com/nicklloyd/ts-boilerplate.git my-project
cd my-project
yarn

2. Validate the setup by running the tests:

yarn test

3. Remove the Original Git History

To start fresh with your own version control history, remove the existing .git directory:

rm -rf .git

4. Initialize a New Git Repository

git init

5. Update the package.json with your project details.

6. Add All Files to the New Repository

Add all the files in your new project directory to the repository:

git add .

7. Create a New Repository on GitHub

Go to GitHub and create a new repository. Do not initialize the repository with a README, .gitignore, or license since your project already includes these files.

8. Add the GitHub Repository as a Remote

Replace your-username with your GitHub username and your-repository with the name of your new repository. Then, add the GitHub repository as a remote to your project:

git remote add origin https://github.com/your-username/your-repository.git

9. Push to GitHub

Push your commits to the new GitHub repository:

For the main branch:

git push -u origin main

10. Start Developing

At this point, you've successfully created a new project from the template and started your own Git repository. You can now start developing your project.

Remember to update the project's README.md and other documentation to reflect your project's name and specifics.

ts-boilerplate's People

Contributors

nicklloyd avatar

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.