Skip to content

ulrich-merkel/www.ulrichmerkel.com

Repository files navigation

Build Status Coverage Status Code Climate Website npm node js-standard-style MIT license Known Vulnerabilities

About

This is just a playground for React and all the corresponding ecosystem technologies. It features the following technologies:

Frameworks and tools

  • React - JavaScript library for building user interfaces
  • Redux - Predictable state container for JavaScript apps
  • Reselect - Selector library for Redux
  • Babel - A JavaScript compiler for Using next generation JavaScript today
  • Webpack - A bundler for JavaScript and friends
  • Express - Fast, unopinionated, minimalist web framework for Node.js
  • CSSNext - Use tomorrow’s CSS syntax today
  • SASS - Stable and powerful professional CSS extension language
  • Yarn - Fast, reliable and secure dependency management

Testing and linting

  • ESLint - The pluggable linting utility for JavaScript and JSX
  • Stylelint - A mighty, modern CSS linter
  • Jest - Painless JavaScript testing framework
  • Typescript - Typed JavaScript at Any Scale
  • Snyk - Continuously finds and fixes vulnerabilities in your dependencies
  • Node Security Platform - Helps you keep your node applications secure
  • RetireJS - Detecting the use of JavaScript libraries with known vulnerabilities
  • BackstopJS - An easy way for CSS regression tests
  • PageSpeed Insights - Google pagespeed insights with reporting
  • Travis CI - Test and Deploy with Confidence
  • Codeclimate - Code Climate empowers organizations to take control of their code quality
  • Coveralls - Help you deliver code confidently by showing which parts of your code aren’t covered by your test suite

Documentation

  • JSDoc - An API documentation generator for JavaScript
  • SassDoc - A SCSS documentation system to build pretty docs

Developing

Prerequisites

This is needed to set up the dev environment:

  • Node - Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
  • NPM - npm is the package manager for JavaScript and the world’s largest software registry
  • Yarn - Fast, reliable and secure dependency management

Setting up Dev

This project is loads environment variables from .env files for nodejs projects. To keep private credentials secret i don't add these files to git. Adjust the given .env.sample file and save it as .env.

If you're using Coveralls adjust the coveralls.sample.yml config file to fit your needs and save it as coveralls.yml.

Basic NPM script commands

$ npm run watch
  • Start watching source files and rebuild them when changes occur.
  • Build all files in development mode before start watching.
$ npm run dev
  • Build files in development mode, which is nearly the same as production but without minification.
  • Try to run subtasks in parallel if possible.
$ npm run build
  • Build files in production mode, minify and optimize files as much as possible.
  • Try to run subtasks in parallel if possible.
$ npm run test
  • Executes all testing and linting tools in parallel.
$ npm run doc
  • Generate JSDoc and SassDoc files and folders.

Some links which inspired my work

React & Webpack & JavaScript

Node & NPM

Babel

Boilerplates and examples