the-launch-pad
v2.2.2
Published
The fastest way to bootstrap an app
Downloads
5
Maintainers
Readme
How to Install
npm i -g the-launch-pad
Requirements:
Developers:
🤔 What is the Launchpad?
Launchpad is an interactive CLI wizard used to scaffold a new web application. You install Launchpad globally via npm
and simply run the launch
command. This will, in order:
- Ask for a project name
- Ask for a project description
- Ask if the project is private
- Ask which frontend booster you want to use. (React SPA, NextJS, NuxtJS, etc)
- Ask which backend booster you want to use. (GraphQL + MongoDB, Flask + PostgreSQL, etc)
- Ask for a GitHub token (used to create repositorie(s) and configure git)
- Create a main GitHub repository based on your project name
- Create additional GitHub repositories for each booster selected
- Clone the main repository to wherever you ran
launch
from - Add the additional booster repositories as git submodules to the main repository
- Commit and push the changes made from instantiating the submodules
- The project is now ready to be run and deployed via instructions from an auto-generated README.md file
📝 A Note About Boosters
Boosters are just individual boilerplates that are expected to contain run and deployment instructions. Without
boosters, the Launchpad would be useless. Currently, boosters can be found within my
GitHub repositories. Boosters must respect the following
repository naming convention: [frontend|backend]-booster-[library/framework]
. For example, a booster name may
look like frontend-booster-nextjs
. Booster repositories must also contain a description, which is what the Launchpad
will use for the selection options.
A full set of Booster guidelines can be found here.
🚀 Getting Started
On your GitHub account, navigate to Settings / Developer settings / Personal access tokens. Generate a new token with the
repo
scope. Copy this token and be ready to use it during the launch process.Install Launchpad
npm i -g the-launch-pad
Blast off!
launch
⚖️ License
Code released under the MIT License.