Boiler.js is a desktop application for software developers to quickly find and
set up boilerplates on their local machine with a single click
- Clone this repo. on your local machine
git clone https://github.com/MLH-Fellowship/Boiler.js.git
- Navigate to the root directory in your terminal
- Run
npm run electron-build
. This will install all the necessary packages - Run
npm run try
. This builds the frontend files for use in electron, then launches the desktop application. - Run
npm start
to launch electron after build files are created.
Note
: You must run npm run try
every time the frontend is modified in order to view your changes.
Alternatively
: use npm run develop
if you want to modify the code, so you can view your changes instantly.
add information about how to use electron as exe file
- press the
+ New Boiler
Button
- fill in the required information in the modal
Name
: refers to the name of your BoilerType
: synonomous to tags, ex: ReactDescription
: tell the world what your Boilerplate is for!Link
: to the Github repo. where your Boiler is saved
- Press
Create
, and you're done
- search for what kind of Boilerplate you want
- click the
Clone from Github
button, and all the work is done for you!
Devpost Submission: https://devpost.com/software/boiler-js
Lily Tang | Clara Chick | Caleb Lim | David Knox |
---|---|---|---|
π» π€ |
π π» π€ |
π» π€ |
π π» π€ |