mintbean-cli

A command line interface for easy creation and deployment of submissions for Mintbean hackathon challenges

How to make your first contribution

One of the goals of this project is to make it easy for first-time open source contributors to work on the project.

Check out https://github.com/firstcontributions/first-contributions to understand how to contribute to open source projects like this one.

How to Contribute

Development flow

You can run the CLI for dev purposes by running the command npm start.

If you want to test that mint gets loaded up during development, run npm link.

Install

npm install -g mintbean-cli

Pre-requisites

You need to have node and git installed on your machine. If you don't:

LINUX sudo apt install node git

MAC brew install node brew install git

WINDOWS Google it :)

Usage

Run mint for list of commands

Creating and deploying projects

If it is your first time using mintbean-cli, first connect to GitHub with config (see below).

Suggested flow for new projects

mint new <my-project>
cd <my-project>
mint repo
mint deploy

or for the cool kids:

mint n <my-project>
cd <my-project>
mint r
mint d

Config

The first time you use mintbean-cli you need to hook it up to your GitHub. Don't have a GitHub account? Make one!

mint config -g <github-username> -t <token>

Create a new GitHub personal access token here. Be sure to assign this token full scope of 'repo' and 'user'. You can reset your token anytime and update your mint config.

Advanced: the connection type defaults to SSH. You can specify HTTPS connection instead with -H flag (or switch back to SSH with -S).

mint config -g <github-username> -t <token> -H

View your config settings anytime with mint config -v.

Development

npm start or yarn start

Starts a local development server to display your code's output (look for localhost link). Changes to your code automatically updates when you save.

Deployment

If you haven't yet, create a remote repo: mint repo -cp

Then just run mint deploy anytime and every time you want to update your deployment.

Deployment defaults to GitHub pages, but you can define your own custom 'predeploy' and 'deploy' commands in package.json> "scripts" if you prefer some other building/hosting platform.

Be patient on first deploy to GitHub pages - it can take up to a minute or two before the page is ready :)

Templates

These start templates are currently available. They all come ready-to-deploy to GitHub pages.

react-gh-pages

Basic Create React App template.

vanilla-js-gh-pages

Basic vanilla JavaScript template that allows you to preview your project on a local server (npm start or yarn start to start the server)

vue-gh-pages

Basic Vue CLI template.

svelte-gh-pages

Basic Svelte CLI template.

bulma-theme

A theme workspace for Bulma CSS, complete with a test page with all of Bulma's components.

phaser-js-gh-pages

Starter Kit for a full-fledged PhaserJS game project

WARNINGS

1. Pick a unique project name that won't conflict with your existing GitHub repos
2. mint commands will break if you change your project name... sorry.
3. VANILLA-JS TEMPLATE: if you change your entry file from ./index.html, be sure to update the deploy and predeploy npm scripts commands in package.json

Commands

In general, run all commands at the project root!. Commands you can run anywhere: mint [-h|-V], mint config or mint new

cmd	description
mint [-h	--help]
mint -V	--version
mint new	n [project-name]
mint repo	r, -O, --org [organization]
mint config [-v|--view] [-g|--github] [-t|--token]	Set up or view config (Github credentials etc.) options: (-v) view current config (-g) set github username (-t) set github personal access token
`mint deploy	d`

Developers

Testing

Testing is not yet set up for developers. Coming soon.

New templates

Have a project starter template idea? Submit it here

Bugs

Report them here