@pak11273/monorepo
v3.10.0
Published
CLI for monorepos
Downloads
3
Maintainers
Readme
Scaffold a MONOREPO with this Node CLI
Build a monorepo with Lerna, Yarn Workspaces, and options for clients, servers, website, mobile
Current Options:
- servers: "express"
- templating engines: "hbs", "ejs", "pug"
- clients: "react", "create-react-app 3.3.1"
Features
- Custom options for a javascript-based fullstack repo
- Automatic github repository setup
- Adds a typescript option support for your client module
- Webpack dev server w/hot reloading for react apps
Requirements
- Lerna v3.18.4
- Yarn v1.19.1
- Node v12.4.0
- Git v2.11.0
- GitHub account OR Bitbuck accout
- Create-react-app v3.3.1
*May or may not work with lower versions
Installation Steps (if applicable)
- Install the module globally with
npm install @pak11273/monorepo -g
from within the project directory - Create a directory
mkdir <your monorepo name> && cd <your monorepo name>
- Run
repo <your monorepo name> <description>
- Follow the instructions
- cd into the root folder after the setup is completed and run
yarn bootstrap
- cd into shared package and run
yarn build
- cd into packages/client and run
yarn start
to test react clients
Notes
- Frontend packages (eg. web, client, mobile) are installed with styled-components for styling. You can
yarn remove styled-components
inside each package to remove it and use your own css styling.
- Ports for packages:
- web: 8080
- client: 3000
- server: 5000
RoadMap
- ~~Add react option for client~~
- ~~Add a basic setup for react clients only~~
- ~~Add webpack option for bundler~~
- ~~Add create-react-app option for client~~
- Add a documentation website
- Add typeorm option for orms
- Add apollo option for graphql
- Add gatsby option for web
- ~~Add nextJS option for web~~
- Add rollup option for bundler
- Add nextJS option for client
- Add gatsby option for client
- Add react-native option for mobile
- Add create-react-native-app option for mobile
- Add basic user authentication for express
- Add basic user authentication for graphql
- Add github-actions option for ci
- Add circleci option for ci
- Add travisci option for ci
- Add knex option for orms
- Add sequelize option for orms
- Add relay option for graphql
License
The MIT License (MIT)