Skip to content
A Pristine starting point for typescript react projects
TypeScript JavaScript HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Initial commit Jul 1, 2019
.github/ISSUE_TEMPLATE Initial commit Jul 1, 2019
public feat: initial commit Jul 2, 2019
src feat: initial commit Jul 2, 2019
.editorconfig Initial commit Jul 1, 2019
.gitignore Initial commit Jul 1, 2019
.releaserc fix(.releaserc): remove npm publish Jul 2, 2019
BUILDING.md Initial commit Jul 1, 2019
CHANGELOG.md chore(release): 1.0.2 [skip ci] Jul 2, 2019
CIRCLECI.md
CONTRIBUTING.md Initial commit Jul 1, 2019
CONVENTIONAL_COMMITS.md Initial commit Jul 1, 2019
LICENSE.md Initial commit Jul 1, 2019
README.md fix(README): add note about using template button Jul 2, 2019
RELEASING.md Initial commit Jul 1, 2019
VERSIONING.md Initial commit Jul 1, 2019
jest.config.js Initial commit Jul 1, 2019
package-lock.json chore(release): 1.0.0 [skip ci] Jul 2, 2019
package.json
tsconfig.json feat: initial commit Jul 2, 2019
tsfmt.json Initial commit Jul 1, 2019
tslint.json Initial commit Jul 1, 2019

README.md

Pristine Typescript React

A typescript open source repository in its original condition. It leverages Typescript and React to give a good starting point for new and existing projects.

Pristine Typescript React a fork of Pristine.

There are a lack of repositories to start from to build community driven open source projects. Pristine Typescript is a complete starting point, it follows a Documentation Driven Development approach, and can be used as a resource to augment existing documentation.

How to use Pristine in your project

There are 3 options for using pristine with your project.

  1. Fork this repo as the start of your own, OR
  2. follow these instructions to use it on an existing repository.
  3. Use the Use this template button on this repository.

Documentation Driven Development

There are many ways to drive open source development. Documenting the problem in the README gives a middle ground between technical and non-technical specifications. This allows organizing solutions to this challenge around community and documentation.

[...] a beautifully crafted library with no documentation is also damn near worthless. If your software solves the wrong problem or nobody can figure out how to use it, there’s something very bad going on.

Conventions and Specifications

This repository has some strong opinions built in like circleci, semantic-release, npm. So feel free to fork and change it at your own discretion. It is only meant to be a starting point. That being said:

Using conventions, documentation and specifications make it easier to:

  • communicate the problem you are solving
  • ease onboarding
  • build and use composable tools
  • promote open source contribution and engagement
  • promote issue and feature discussion on Github itself

Resources

Getting Started

To get started, fork or duplicate the repository. Then edit this file and delete everything above this line.

Then edit the package.json and change the name and homepage fields to match your newly created repository.

Contributing

How to contribute, build and release are outlined in CONTRIBUTING.md, BUILDING.md and RELEASING.md respectively. Commits in this repository follow the CONVENTIONAL_COMMITS.md specification.

You can’t perform that action at this time.