Giter Site home page Giter Site logo

io arc

It's so easy! build in 5 minutes! WEB/PWA/SPA boilerplate CLI.

io arc -WEB/PWA/SPA boilerplate CLI-

Install

$ npm i -g @io-arc/cli
# or
$ yarn global add @io-arc/cli

Usage

$ cd <Project Directory>
$ io-arc

Documents | Set up configuration | Builds

Select language and frameworks

HTML template engine

  • HTML (with handlebars)
  • Pug

The global constants that are available: HTML (with handlebars), Pug

CSS language

  • CSS
  • SASS(SASS/SCSS)
  • Stylus

JS preprocessor

  • Babel
  • TypeScript

JS framework

Automatically available in selected preprocessors.

  • Vue (Babel/TypeScript)

Local Server

Other default use

Directory structure

Create directory structure below.

<Project Directory>
    ├ config/ (settings)
    │   ├ default.yml (site settings)
    │   ├ development.yml
    │   ├ production.yml
    │   ├ local.yml (build settings)
    │   ├ local-development.yml
    │   ├ local-production.yml
    │   └ webpack.extends.js
    ├ config-vue/ (select Vue only)
    │   └ .pug-lintrc.json
    ├ src/ (working directory)
    │   ├ css/
    │   ├ html/
    │   ├ img/ (using file-loader)
    │   ├ js/
    │   ├ static/ (file copy)
    │   └ yaml2json/
    ├ types/ (select TypeScript only)
    ├ .babelrc (select Babel only)
    ├ .browserslistrc
    ├ .editorconfig
    ├ .eslintrc.yml
    ├ .pug-lintrc.json (select Pug only)
    ├ .gitignore
    ├ .npmrc
    ├ .prettierrc
    ├ tsconfig.json (select TypeScript only)
    ├ package.json
    └ webpack.config.js

Build options

Internally, the build can be tweaked using the node-config library.

Site settings

Settings related to the website, such as the site title, are specified in the default.yml or development.yml or production.yml.
See example for default.yml.

See documents.

Build settings

The build configuration is done in local.yml.
See example for local.yml.

See documents.

Extending the webpack build

There are several extensions available on the user side as well.
The extension is configured in <project>/config/webpack.extends.js.

The extensible webpack options are as follows.

See example.

See documents.

Using undefined node-config data on the client side

If you want to use global constants other than those available in TypeScript and Babel, you can use CONFIG global constants.

# config/local-development.yml
api: https://foo.com
console.log(CONFIG.api)
// result => https://foo.com

* If you are using TypeScript, please define the type by yourself.

io arc project's Projects

io-arc icon io-arc

It's so easy! build in 5 minutes! WEB/PWA/SPA boilerplate CLI.

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.