Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anikethsaha/create-web-app
Select your project type and use any boilerplate to get started! a project where you dont need any manually boilerplate adding phase in your software development phases
https://github.com/anikethsaha/create-web-app
boilerplate cli express javascript mongodb nodejs project-starter react typescript webapp webapp-boilerplate yeoman-generator
Last synced: 27 days ago
JSON representation
Select your project type and use any boilerplate to get started! a project where you dont need any manually boilerplate adding phase in your software development phases
- Host: GitHub
- URL: https://github.com/anikethsaha/create-web-app
- Owner: anikethsaha
- License: apache-2.0
- Created: 2019-05-26T15:41:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:43:27.000Z (almost 2 years ago)
- Last Synced: 2024-10-01T09:34:00.435Z (about 1 month ago)
- Topics: boilerplate, cli, express, javascript, mongodb, nodejs, project-starter, react, typescript, webapp, webapp-boilerplate, yeoman-generator
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@buildtip/create-web-app
- Size: 572 KB
- Stars: 15
- Watchers: 2
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
> # :mega: Re-written of this package in a new project is coming. so no development are going to happen in this repo and package. Please refer [**plan for this project**](https://github.com/buildtip/create-web-app/issues/56)
Create Web App
### Donation
## Installation
```bash
# Recommended
$ npm i -g @buildtip/create-web-app
$ cwa
or
# If want to install and run it locally
$ npx @buildtip/create-web-app
```
## Usage
```bash
$ cwa --help
Usage
$ cwa [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 :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.**
## Commands
### ` $ cwa list `
It lists the available Templates present as a project starters
```bash
$ 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
```bash
$ 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
```bash
$ 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 :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:
Please refer [`CONTRIBUTING.md`](/CONTRIBUTING.md)
## How to Install and Use Locally
1. Clone It
2. `$ npm install`
3.
```bash
$ 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:
### For v1 release
- [ ] Docs
- [x] Better CLI
- [ ] More Tests
- [ ] More Boilerplates
- [x] Code refactor (Done Partially --> more to do)
## Test
```bash
npm test
```
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Anix
🚇 ⚠️ 🤔 🚧 🎨 💻
LOLDeveloper
📖
Chandima Ranaweera
🐛
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!