Skip to content
/ template-general Public template

A general Open Source project template using some opinionated conventions.

Notifications You must be signed in to change notification settings

ggondim/template-general

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

replace these tokens by its values then delete this section
${PROJECT NAME} = project name
${PACKAGE NAME} = npm package name
${USER} = repository user name
${REPO} = repository name


${PROJECT NAME}

Short description of project.


Basic usage  |  Installation  |  Advanced usage  |  API  |  Table of contents


Features

Feature name 🎁
Feature definition/description



TL;DR: basic usage

[](https://npm.runkit.com/${PACKAGE NAME})

See more usage topics in usage section.


Table of contents


Installation

Requirements

${PROJECT NAME} was tested for the environments below. Even we believe it may works in older versions or other platforms, it is not intended to.

See tested environments
Environment Tested version
OS Ubuntu 20.04
Node.js 12.16.3
Package Manager npm 6.14.5
Platforms server, browser (Chrome latest)

Installing

Via package manager

![](https://nodei.co/npm/${PACKAGE NAME}.png?downloads=true&downloadRank=true&stars=true)

$ npm install --save ${PACKAGE NAME}
See other options

Yarn

$ yarn add ${PACKAGE NAME}

Unpkg

[https://unpkg.com/:${PACKAGE NAME}](https://unpkg.com/:${PACKAGE NAME})

<script src="https://unpkg.com/:${PACKAGE NAME}" />

Module/language support

This means you:

  • May use the module with import, require or define
  • Should use polyfills or transpilation if you want to support older environments
See JavaScript features used by this package and its versions
Version Features used
ES5 all common features
ES6 const, class, destructuring binding, default parameters, let, object short notation, arrow function syntax, template literal syntax
ES8 async functions, trailing comma in arguments lists
ES9 object spread property

↟ Back to top


Usage

An example title of an advanced usage topic


↟ Back to top


Extending

Writing plugins

Community plugins


↟ Back to top


Help

FAQ

1. First question?

Answer here

Support

If you need help or have a problem with this project and you not found you problem in FAQ above, start an issue.

We will not provide a SLA to your issue, so, don't expect it to be answered in a short time.


↟ Back to top


API

ClassOrModule.js class|module

Members

memberName type?_=defaultValue

Description what it is

Properties

propertyName type

Description of what it is

Methods

methodName() function(arg1, optional?):ReturnType

Description what it does

Arguments

Argument Type Required Default Description
arg1 Type true default Description of argument

Returns

AzureFunctionCascade the current instance of AzureFunctionCascade.

Callbacks

arg1Callback async function (context, STOP_SIGNAL?):any
Argument Type Required Default Description
arg1 Type true default Description of argument

Returns: description of callback return.


↟ Back to top


Tecnhical concepts

Motivation and design

${PROJECT NAME} was inspired from ...

Features

Beyond the features previous listed, ${PROJECT NAME} also have:

  • Feature

Related projects

Similar projects


↟ Back to top


Contributing

If you don't want to code

Help us spreading the word or consider making a donation.

Star the project

Tweet it

Donate

Add your company name to the Who is using secion

Make a pull request or start an issue to add your company's name.

If you want to code

Code of conduct

We follow Contributor Covenant Code of Conduct. If you want to contribute to this project, you must accept and follow it.

SemVer

This project adheres to Semantic Versioning 2.0.0.

Roadmap

If you are not solving an issue or fixing a bug, you can help developing the roadmap below.

See the roadmap
  • Create something
  • Improve documentation

↟ Back to top


Hall of fame

Who is using

Contributors

Backers

Sponsors


↟ Back to top


License

Licensed under the MIT License.


↟ Back to top


About

A general Open Source project template using some opinionated conventions.

Resources

Stars

Watchers

Forks

Packages

No packages published