Plumier provided some official project template starters contains minimum source files, package setup and some default configuration required to start a fresh new API project. Project starters hosted in this repository on each branch.
Each project templates consist of:
- Minimum source file such as application bootstrap, controller etc.
- Minimum source file for unit testings using Jest
- Minimum dependencies required on
- VSCode launch configuration to debug the application and debug the test
- Some TypeScript files for post install script and deployment
There are several project starter available on the repository:
|Plumier||Basic Plumier application starter|
|Plumier, React||Monorepo SPA starter. Plumier as the API backend and React as the front end|
|Plumier, Vue.js||Monorepo SPA starter. Plumier as the API backend and Vue.js as the front end|
Some software required in your local development to make things run smoothly.
Test the following code in your terminal application (Terminal, Cmd, Powershell, Git Bash) to make sure everything installed properly.
$ node -v $ npx -v $ yarn -v $ code -v
Make sure all commands above run correctly.
Plumier Starter CLI App
plumier-starter cli application to download the project template you need, by execute command below:
$ npx plumier-starter
Command above will download and execute
plumier-starter application temporarily. Type the project name and select the starter you wish. Wait a moment until yarn finish installing dependencies. After process finished execute command below to run start the Plumier application.
cd <project name> yarn debug