/SENT-template

Skip setup and start code with SENT (Sapper Express Node Template) and other tools

Primary LanguageJavaScriptMIT LicenseMIT

SENT-template

https://github.com/Zimtir/SENT-template

Sapper Express Node Template

Logo

GitHub package.json version GitHub issues GitHub forks GitHub stars GitHub license

GitHub issues GitHub forks GitHub stars GitHub license

code style: prettier code formatting: eslint

build and publish linters and tests

Docker Stars

GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch) GitHub package.json dependency version (dev dep on branch)

Coverage by tests

Design

Design

Usage

  • Create a repository based on SENT-template

    # for Rollup
npx degit "Zimtir/SENT-template" my-app

  • Install packages

    • npm run install:dev - Install only required packages for simple development (no test support and other tools)
    • npm run install:dev:full - Install all packages
    • npm run install:prod:full - Install all packages to execute tests, storybook and so on at production environment
    • npm run install:prod - Install only required packages to run production

Testing

  • npm run test:dev or npm run test:prod - Execute all tests
  • Note: setup IS_CODE_COVERAGE_ENABLED='true' in environment variables to print at output a coverage by tests

Swagger

Swagger configuration

Docker

Production

  • Application

    • The running of bundles in container
    • Note: Sure to execute the build before npm run build
    docker-cmpose up sent-template

Development

  • Application

    • The running of application in development mode inside a container
    docker-compose -f docker-compose.dev.yml up web

  • Storybook

    • Demonstrates all components that can be used in development
    docker-compose -f docker-compose.dev.yml up storybook

  • Nginx

    • The hosting of bundles through Nginx
    • Note: Sure to execute the build before npm run build
    docker-compose -f docker-compose.dev.yml up nginx

  • Tests

    • Allows to execute all tests in the container
    docker-compose -f docker-compose.dev.yml up test

Docs

Wiki

List of features