https://github.com/yowainwright/developer-ci-benefits-demo

This is a demo repo setup to go along with the Developer CI Benefits Talk
https://github.com/yowainwright/developer-ci-benefits-demo

ci ci-benefits circleci npm

Last synced: 4 months ago
JSON representation

This is a demo repo setup to go along with the Developer CI Benefits Talk

• Host: GitHub
• URL: https://github.com/yowainwright/developer-ci-benefits-demo
• Owner: yowainwright
• License: mit
• Created: 2018-08-06T05:46:21.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T13:01:17.000Z (over 3 years ago)
• Last Synced: 2025-08-17T16:42:04.902Z (11 months ago)
• Topics: ci, ci-benefits, circleci, npm
• Language: TypeScript
• Homepage: https://bit.ly/2NGQqiJ
• Size: 1.07 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
![Developer CI Benefits Demo Banner](https://jeffry.in/assets/developer-ci-benefits/developer-ci-benefits-demo.svg)

# Developer CI Benefits Demo

[![CircleCI](https://circleci.com/gh/yowainwright/developer-ci-benefits-demo.svg?style=svg)](https://circleci.com/gh/yowainwright/developer-ci-benefits-demo)

This repository show's a CI setup. It works using steps described in the [Developer CI Benefits Talk repository](https://github.com/yowainwright/developer-ci-benefits).

This repository should be used to help setup viewers repositories or for reference when reading the  [Developer CI Benefits Talk repository](https://github.com/yowainwright/developer-ci-benefits).

## High level repository features

Listed below are tools used to setup this Repository and its CI with links to tool information as well as a link to where the tool is used in this repository.

- **[EditorConfig](https://editorconfig.org/):** provides a standard [config](.editorconfig) for code editors.

- **[Markdownlint](https://github.com/markdownlint/markdownlint);** ensures that [markdown](.markdownlintrc) is written to a standard.

- **[NVM](https://github.com/creationix/nvm):** defines the version of [node](.nvmrc) to be used for this project

- **[TypeScript](http://www.typescriptlang.org/):** provides [type checking](/src/index.ts); helps articulate what code is doing.

----

### Can JS be used instead of TS

JavaScript can be used instead of TypeScript. The list below articulates the differences at a high level.

- This repository uses TypeScript because TypeScript is a great tool for articulating code.

  - TypeScript is 100% interchangeable with JavaScript.

    - To use JavaScript instead of TypeScript, use JavaScript with Babel.

    - To test JavaScript instead of TypeScript, use Jest.

    - To lint JavaScript instead of TypeScript, use ESLint.

- [Read more](https://github.com/yowainwright/developer-ci-benefits) about the talk by clicking the "Developer CI Benefits Talk" or "Read more" links.

----

## Reference

Listed below is attribution to this repository and where this repository can be referenced.

- This is a demo repo setup to go along with the Developer CI Benefits Talk.

- This is a dependency repository example for the [Developer CI Benefits Talk](https://github.com/yowainwright/developer-ci-benefits).

- This repository is a published on [NPM](https://www.npmjs.com/package/developer-ci-benefits-demo). It development a full CI process.