Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 4.15 KB

README.md

File metadata and controls

105 lines (66 loc) · 4.15 KB
Raw

TypeScript Bootstrap

A TypeScript bootstrap project: to start your project out without hassle. This project aims to give you the best tools you need to start your project on the right foot. When forking this project to start out your own unique idea, take some time to fill out the information here in this README. Remember, just like this README, your README.md file is the first contact to the end user. Most people don't read any more documentation (although I'm sure you'll have lots!) and really they should be able to get started with no more information than from here. Give them everything they need to get started on their own wonderful project.
The following is simply a template of information to give. It is not final, it is not correct, it is simply a guidline of best practices.

Now remove this part and fill out the rest with your unique project information. Everything below can be removed, but some can be updated with your project specific information of course.

Be sure to take out other referenceds in the package.json file to this before your first commit. Remember to give credit where it is due.

Created by Spencer Pollock Contact me

[Project Title]

[A short project description goes here. Up to a paragraph but no more.]

TypeScript Open Source Love semantic-release

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install and run:

# make sure you can run in the console
node --version
npm --version

Installing

Clone the repo to your computer.

Run in the terminal:

npm install
node index.js

Running the tests

To run the tests, use npm test, that will run all the tests. There is also test:unit test:functional test:integration.

Coding Style in Tests

See the Jest project.

Deployment

You can run it right from your console with either: npm start or node index.js

There are GitHub workflows that run actions in .github/workflows that will automate the testing, coverage reports, documentation, versioning and publishing of the package to both GitHub Packages and the NPM Repository. Testing is completed by GitHub Actions with Jest on all systems (Windows, macOS and Linux) as well as the latest 3 versions of Node (11, 12, 14) and the coverage reports are sent to Codecov if you have the app connected to your GitHub account. Documents can be found at the GitHub repo project website (generated from the readme) and appending /docs onto the URL. Packages can be found at both the NPM Repo and GitHub repo.

Built With

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
  • Billie Thompson - Provided README Template - PurpleBooth

Created by Spencer Pollock. Contact me