Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.05 KB

README.md

File metadata and controls

72 lines (50 loc) · 3.05 KB
Raw

simple-ts-react-ssr-app

Greenkeeper badge

SSR React starter project written in typescript, includes, webpack, babel, jest & enzyme.

Commands

Initialize it locally:

$ npx simple-ts-react-ssr-app myFolder

Will create a copy of the project inside myFolder.

  • npm run start--dev run both server and client dev
  • npm run build build bundle (it is recommended to build the bundle first once started the project to create the initial server.js file)
  • npm start start the project (requires npm run build first)
  • npm run test run tests (both back and front end)
  • npm run type-check run typescript' manual typecheck
  • npm run tslint lint project

Project structure

The boilerplate structure and files are the same as this repo minus the bin folder, everything else is exactly the same.

*root*
|
├── */src/*
│   ├── */assets/* where images and stuff are stored
│   ├── */containers/* react-router jsx pages
│   ├── *App.tsx* main layout
│   ├── *Routes.tsx* front-end routes
│   ├── *index.tsx* javascript entry point
│   ├── */custom-types/* contains custom types
│   │   └── *index.d.ts* only "*.png" for now (to make images import work)
│   ├── *style.scss* styling
│   └── */tests/* contains test environment (Jest + Enzyme)
│       ├── */__mock__/* contains setup to provide a valid path for imports
│       ├── */_tests__/* the actual tests
│       └── *setup.ts* setup for enzyme for react 16
├── *package.json* the whole package.json with every dependency and script, nothing is kept hidden
├── *tslint.json* tslint config
├── *tsconfig.json* typescript config
├── *.babelrc* babel config (polyfills)
├── *webpack.config.js* webpack config, it has a dev and prod environment
├── *index.html* entry point
└── *README.md* this file

Tests

The testing environment is written in Jest and Enzyme. The included tests are very basic and only check the proper render of base components + routes, there are no snapshot tests, I did not feel they were needed being the components really basic, at the first change they would need to be updated, imho setting the wrong approach of "hey tests are broken, let's regenerate snapshots again". While still basic, the default tests are easy to manage and expand, providing a smoother curve into testing with JavaScript and React.

Tslint

This project uses Typescript recommended specs plus Typescript react specs so you can write error-free react and typescript code, if you use Visual Studio Code, you can install tslint from the extension tab to activate this function, other editors just google name of the editor + tslint you will find how to enable it for your editor.

How to contribute

I wrote a small guide on how to contribute and the common etiquette to follow.