react-ts-scaffolding's Introduction

React + TypeScript Scaffolding

A set of components arranged in a typical page layout.

This project is deployed at react-ts-scaffolding.netlify.app.

Usage

yarn install
yarn start to run the project locally
yarn test to run unit tests

Project

Set up with the create-react-app TypeScript template.

This project is a Single Page Application in the literal sense. If multiple pages were required, I'd add a router in app.tsx and move all pages to a pages or templates directory.

Components follow this structure:

react-ts-scaffolding/
└─ src/
   └─ components/
      └─ aside/
        ├─ aside.css
        ├─ aside.test.tsx
        └─ aside.tsx

Unit tests are colocated with component source code to keep them managable if this project were to scale.

Layout

Note - A, B, and C are asides.

Mobile/tablet viewport size (<= 1200px):

+---------------------+
|        header       |
+---------------------+
+---------------------+
|                     |
|                     |
|       counter       |
|                     |
|                     |
+---------------------+
+---------------------+
|          ||         |
|    A     ||    B    |
|          ||         |
+---------------------+
+---------------------+
|                     |
|           C         |
|                     |
+---------------------+
+---------------------+
|                     |
|        footer       |
|                     |
+---------------------+

Desktop viewport size (>= 1200px):

+---------------------+
|        header       |
+---------------------+
+---+ +---------+ +---+
| A | |         | |   |
|   | |         | |   |
+---+ | counter | | C |
+---+ |         | |   |
| B | |         | |   |
|   | |         | |   |
+---+ +---------+ +---+
+---------------------+
|                     |
|        footer       |
|                     |
+---------------------+