JTongay / record-label-ui

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

TSX React Starter Kit

This is a starter kit for bootstrapping React applications in TypeScript. Complete with unit/integration testing platforms, material ui, starter error boundary, and written in a modern React style (v16.8)

Motivation

When trying to bootstrap a new React application, it can sometimes be a headache. Sure, create-react-app is a thing and it has extensions, but I couldn't find any that had exactly what I wanted. So then I decided to create my own shell React App with everything I wanted, and maybe one day I will make this an extension of create-react-app.

Build status

** Doesn't work for now **

Build Status Windows Build Status

Screenshots

Include logo/demo screenshot etc.

Tech/framework used

Built with

Tested with

Installation

  • Install project dependencies
yarn install
  • Install integration test dependencies
cd integration/
yarn install

Tests

There are two different test suites and methodologies. Unit and Integration tests.

Unit Tests

Unit tests run automatically as part of the dev build server, but if you were to want to run them independently:

yarn test

Integration Tests (Cypress)

Cypress is a testing framework that is meant to be used along-side your application.

  • Start your dev server in one shell tab
yarn start
  • In another shell tab, move into the integration directory
cd integration/
  • Open the Cypress test runner in the integration directory
yarn start
  • Click on your test files to run, or click the button to run all specs

How to use?

This project follows traditional React design patterns. Presentation/Functional components, Hooks, Error Boundaries, etc. Folder structure should be self explanatory, but components live in components/, feature components live in sections/ and any shared services like in services/

Contribute

** Contribution guideline coming soon... **

License

MIT © Joseph Tongay

About


Languages

Language:TypeScript 50.6%Language:JavaScript 48.5%Language:HTML 0.9%