Nighttime Pachinko Marathon
    Have ideas to improve npm?Join in the discussion! »

    @buildtip/create-web-app

    1.1.3 • Public • Published

    logo

    Create Web App

    Build Status Lic NPM Version NPM Downloads Join the chat at https://gitter.im/create-web-app/community Renovate enabled All Contributors

    Installation

    # Recommended 
     
    $ npm i -g @buildtip/create-web-app
    $ cwa
     
    or
    # If want to install and run it locally 
     
    $ npx @buildtip/create-web-app
     

    Usage

    $ cwa --help
     
      Usage
        $ cwa <command> [options]
     
      Available Commands
        list      List All The templates Available
        run       [WIP] Gives the command to run the Project
        create    create a project passing the template and your project name
     
      For more info, run any command with the `--help` flag
        $ cwa list --help
        $ cwa run --help
     
      Options
        -v, --version    Displays current version
        -h, --help       Displays this message
     

    About 📚

    This package is a simple node cli tool based on yeoman generator which when run will simply ask you some simple question and then will generate a simple starter project to kickstart you development

    This is currently having starter project based on

    1. MERN stack : MongoDB + ExpressJS + ReactJS + NodeJS
    2. MERNG stack : MongoDB + ExpressJS + ReactJS + NodeJS + GraphQL
    3. TMEN 😜 (Sorry for this wierd word) stack : Typescript + MongoDB + ExpressJS + NodeJS

    And Many More Coming Soon ...

    This project is focused on helping developers increasing their starting speed. These Boilerplates are light weight and proven ones. More boilerplates are required for this project with different stacks.

    Do Contribute with this boilerplates and new ones.

    Commands

    $ cwa list

    It lists the available Templates present as a project starters

    $ cwa list --help
      Description
        List All The templates Available
     
      Usage
        $ cwa list [options]
     
      Options
        -h, --help    Displays this message
     

    $ cwa run [project-name] [--src]

    It will give the accurates commands to run the projects and it will list the available commands present in the projects scripts

    $ cwa run --help
      Description
        [WIP] Run the Project
     
      Usage
        $ cwa run [projectname] [options]
     
      Options
        --src         Please Mention the source if the default is changed  (default )
        -h, --help    Displays this message

    [WIP]: To run the command instead to displaying the steps

    $ cwa create

    It will run the generator which is creating the project based on few questions

    $ cwa create --help
      Description
        create a project passing the template and your project name
     
      Usage
        $ create-web-app create [options]
     
      Options
        -h, --help    Displays this message
     
     

    Status 📰

    This project is at very early stage and requires lots of testing, feedbacks, suggestion, refactors ,Features, and improvement. Feel free to Raise an issue and PR

    Contribution Guide 🔧

    • Fork it
    • Create a seperate branch
    • Work on that, Work can be
      • New Features
      • BugFix
      • Better Docs
      • Adding of Tests
      • Code Cleaning + Refactors
      • If any other kind of Contribution, Raise a issue for that and it can be discus there
    • Raise a PR

    Commit Guide

    We are using commitlint for our commit conventions

    Our commit conventions follow this pattern

    type(scope?): subject
    body?
    footer?
    
    
    # type can be
    
    build
    ci
    chore
    docs
    feat
    fix
    perf
    refactor
    revert
    style
    test
    
    
    # example => feat(blog): add comment section
    
    
    

    How to Install and Use Locally

    1. Clone It
    2. $ npm install
     
     
    $ npm run type:build   # To build the typescript compiled 
    $ npm run type:watch   # Typescript in watch mode 
    $ npm run build        # To run the bundler to build the distributed compatable 
    $ npm run watch        # To run the bundler in watch mode 
     
     
      # to run the tool 
    $ node dist/cli
     
     

    TODOs 📄

    For v1 release

    • Docs
    • Better CLI
    • More Tests
    • More Boilerplates
    • Code refactor (Done Partially --> more to do)

    ## Test

     
    npm test
     

    Contributors

    Thanks goes to these wonderful people (emoji key):

    Anix
    Anix

    🚇 ⚠️ 🤔 🚧 🎨 💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i @buildtip/create-web-app

    DownloadsWeekly Downloads

    19

    Version

    1.1.3

    License

    Apache-2.0

    Unpacked Size

    2.57 MB

    Total Files

    118

    Last publish

    Collaborators

    • avatar