Skip to content

sebbo2002/js-template

Repository files navigation

template

License

Here would be a very short description of the project. So in this example it would be a short information that this is a template that I use to start new projects and services.

🚨 Template Usage Checklist

  • Update project name in package.json
  • Create main and develop branches
  • Set develop as default branch
  • Create Docker Repository
    • Add Repository Description
    • Add secret: DOCKERHUB_TOKEN
  • Create npm Repository with npm publish --access public
    • Add secret: NPM_TOKEN
  • Go through repo settings

📦 Installation

git clone https://github.com/sebbo2002/template.git
cd ./template

npm install

⚡️ Quick Start

This is where it would normally say how to use the project. This could be a code example for a library or instructions on how to use a CLI tool.

📑 API-Reference

Is there an API that needs to be documented? Then here would be a nice place for it. If there is external documentation, you can link it here (example).

🙋 FAQ

What's 1 + 2

It's 3 🎉

🙆🏼‍♂️ Copyright and license

Copyright (c) Sebastian Pekarek under the MIT license.

About

A template that I use to start new projects and services.

Resources

License

Stars

Watchers

Forks

Releases

No releases published