Git Product home page Git Product logo

web-template's Introduction

Web App Template

This is a project template to fork off into a new web application. It defines a project skeleton for a simple monorepo containing a backend, a frontend, and a shared library, with a base configuration for tooling (IDE, build, formatting, etc.). This version does not provide configuration for any frontend framework or library. See branches in this repository for more specific configurations.

Tooling

  • Yarn - Version Manager
    • Using plug and play, zero installs, and workspaces features
  • Webpack - Build tool / Bundler
    • Config file written in ts, which requires ts-node and tsconfig-paths
  • VS Code - IDE
  • Prettier - Code Formatting

Note

Yarn provides special SDK for VS Code to use the correct typescript, prettier, and eslint versions. This may need to be re-run on clone.

yarn dlx @yarnpkg/sdks vscode

Future Improvements

  • Add ES Lint default configuration
  • Add additional branches for more specific configurations

Tooling Blocked Enhancements

The following are known improvements that may be possible on future tool updates.

Package Exports and Typescript

Typescript doesn't have support yet for the exports field in package.json. When support for this is added, the shared library can be configured to break up relevant pieces and create more descriptive and deliberate imports.

See [microsoft/TypeScript#35290]

ts-node and ESM

ts-node does not support ESM import syntax. It is needed for writing webpack config in typescript. If this is fixed in the future, the webpack-config.tsconfig.json file could be removed as well as tsconfig-paths.

web-template's People

Contributors

mrose-gnrc avatar rosem1696 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.