Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agneym/create-electrojet
Setup Modern Javascript Applications with a single command
https://github.com/agneym/create-electrojet
carlo cli electrojet-cli electron
Last synced: about 2 months ago
JSON representation
Setup Modern Javascript Applications with a single command
- Host: GitHub
- URL: https://github.com/agneym/create-electrojet
- Owner: agneym
- License: mit
- Created: 2018-12-30T15:44:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T06:20:10.000Z (7 months ago)
- Last Synced: 2024-10-31T23:04:13.051Z (2 months ago)
- Topics: carlo, cli, electrojet-cli, electron
- Language: JavaScript
- Homepage:
- Size: 2.58 MB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
ELECTROJET CLI
## Usage
```
npm init electrojet
```
The CLI will walk you through a set of options for you to select the template/starter.
### Options
#### 1. Template
This option allows you to select the template beforehand.
```
npm init electrojet --template=electron
```
[See list of currently available templates](https://github.com/agneym/create-electrojet#list-of-available-templates)
#### 2. Starter
This option allows you to select a starter beforehand.
```
npm init electrojet --starter=/
```
This format works for repositories hosted on github.
[How do I customise it to work with Gitlab / Bitbucket?](https://github.com/agneym/create-electrojet#)
#### How are they different?
A template offers a default configuration for a given technology. For eg. selecting electron as a template, gives you a package with Electron, Javascript, CSS and HTML.
A starter is much more customised and opiniated in it's design. For example, a starter may have Electron with React and Redux installed and setup for you to start working.
## Why?
See [announcement blog](https://blog.agney.in/electrojet-cli-as-a-service/).
As a User:
:smiley: Get started without worrying about configuration
:yum: Learn configuration for one CLI instead of a million ones
As a package owner:
:wrench: You only have to manage the package extension, we will take care of the CLI and core.
:rocket: The user might have Electrojet CLI installed globally/cached. Also, they might know their way around, so it's lesser docs.
:point_up: Easier updates when extending the core package
## How do I add _______ to the configuration?
1. Add a plugin
There are plugins available for Electrojet that can add functionality to existing configurations.
You can add them to `electrojet.config.js` plugins array.
[List of Plugins](https://github.com/agneym/create-electrojet#list-of-plugins)
2. Roll your own
If you can't find a plugin, you can always write one.
In your plugins directory, add a function that takes the format:
```js
module.exports = {
plugins: [
{
resolve: function (
env, // Current running env, either "dev" or "prod". Allows you to create multiple configs for development and production
context, // The current configuration, mutating this won't help
options, // options from the user, you don't need this for writing custom config
) {
return customConfig; // Return custom configuration
}
}
]
}
```
The webpack configuration object that you return from the resolve functions gets [shallow merged](https://github.com/survivejs/webpack-merge#mergesmartconfiguration-configuration) into running configuration.
## List of available templates
1. [Electron](https://github.com/agneym/create-electrojet/tree/master/packages/electron)
2. [Carlo](https://github.com/agneym/create-electrojet/tree/master/packages/carlo)
3. [Phaser CE](https://github.com/agneym/create-electrojet/tree/master/packages/phaser-ce)
3. [Svelte](https://github.com/agneym/create-electrojet/tree/master/packages/svelte)
## List of plugins
1. [SASS](https://github.com/agneym/create-electrojet/tree/master/plugins/sass)
2. [LESS](https://github.com/agneym/create-electrojet/tree/master/plugins/less)
## How do I build a CLI for my favorite technology?
1. Install `@electrojet/core` for defaults in building Webpages.
2. Use [Node APIs](https://github.com/agneym/create-electrojet/tree/master/packages/core#node-api) for `@electrojet/core` to extend the start and build scripts.
3. If you are building a Template (and not a starter, [see difference](https://github.com/agneym/create-electrojet#how-are-they-different)), give us a PR to include in electrojet templates.
See any of the [packages](https://github.com/agneym/create-electrojet/tree/master/packages) for an example.
## Developing
1. Clone the repository
2. Run following command to install all dependencies
```bash
lerna bootstrap
```
3. Make changes in your branch
4. Run tests with:
```
lerna run test
```
5. Give us a PR
## How do I customise it to with Bitbucket / Gitlab Templates
> Docs in progress