https://github.com/azmisahin/azmisahin-software-web-package-template-nodejs-javascript-v1

package template for nodejs project
https://github.com/azmisahin/azmisahin-software-web-package-template-nodejs-javascript-v1

bdd cd ci conventional-commits coverage dev-container devops docker library linux manager module nodejs package testing

Last synced: about 1 month ago
JSON representation

package template for nodejs project

• Host: GitHub
• URL: https://github.com/azmisahin/azmisahin-software-web-package-template-nodejs-javascript-v1
• Owner: azmisahin
• License: mit
• Created: 2022-05-18T13:31:38.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-11T08:43:52.000Z (almost 2 years ago)
• Last Synced: 2024-11-09T03:48:59.340Z (2 months ago)
• Topics: bdd, cd, ci, conventional-commits, coverage, dev-container, devops, docker, library, linux, manager, module, nodejs, package, testing
• Language: JavaScript
• Homepage:
• Size: 216 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Introduction

Software webpack template for nodejs javascript scripting language : version 0.1

🔖: releasing / 0.1.3

## Example

```js

// package define

const Template = require('../src')

// module instance

var template = new Template()

// a normal status code is returned when the package runs successfully.

process.exit(template instanceof Template == true ? 0 : 1)

```

# Getting Started

TO DO: Things to do when getting started on this project.

- [Documentation](docs/README.md).

# Build and Test

TODO: Will apply your code and project building standards to templates.

* The tests will be applied as in the template projects.

* Development and operation will be planned as test/slot/production.

# Contribute

TODO : The best method of making a contribution will be to comply with the following items.

* Work with algorithms and flowcharts to solve problems.

* Make pull requests to version control systems.

* Stick to Architecture and Design Patterns apps.

* Take care to develop applications with Domain Based Design / Test-oriented development approaches.

* Stick to the architectural patterns used in abstraction software like Model-View-Controller.

- Be consistent in executing maintainable practices with Object Oriented Programming (abstraction, encapsulation, inheritance and polymorphism...) techniques.

* Use behavior-oriented development tools effectively.

* Make it a habit to use Integration testing / Unit Testing / Functional Testing / Automation Tests.

* Be persistent in applying metrics that describe how well the source code has been tested. [ have something to show at meetings: ) ]

* Send your code with traditional commit messages, make your code understandable with static code analysis tools, "code documentation" tools.

* Build event-driven, scalable service applications with serverless application development platforms.

* Follow the steps to improve threading techniques like in services or mobile apps. 

# While starting

In the project; principles and architectural examples of development, code submission, consistent coding styles and development in team environment have been implemented.

- Welcome to us, to contribute See [How to Provide Storey](CONTRIBUTING.md)

- Review the Participant Agreement [Code of Conduct](CODE_OF_CONDUCT.md).