0.1.0 • Published 5 years ago

@buildtip/web-project-starter v0.1.0

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
5 years ago

:rocket: Web Project Starter

Under Development :warning:

About :books:

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 :stuck_out_tongue_winking_eye: (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.

Status :newspaper:

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 :wrench:

  • 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

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 :page_facing_up:

  • To prepare a TODO :grin:

Test

npm test