Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spoonx/swan-cli
The cli for swan
https://github.com/spoonx/swan-cli
Last synced: about 1 month ago
JSON representation
The cli for swan
- Host: GitHub
- URL: https://github.com/spoonx/swan-cli
- Owner: SpoonX
- Created: 2016-01-09T15:59:40.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-10-02T07:58:24.000Z (about 7 years ago)
- Last Synced: 2024-04-25T22:01:59.586Z (8 months ago)
- Language: JavaScript
- Size: 48.8 KB
- Stars: 12
- Watchers: 6
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Swan CLI
*The command line interface for SWAN.*
**Unmaintained! This setup requires an overhaul, which won't happen any time soon.**
SWAN as a stack runs [**S**ails](http://sailsjs.org/), [**W**aterline](https://github.com/balderdashy/waterline), [**A**urelia](http://aurelia.io) and [**N**ode](https://nodejs.org).
**Note:** This module is work in progress.
It already provides some useful methods, but isn't _done_ yet.
Contributions are more than welcome.
## What?
The SWAN stack makes developing applications a lot easier and faster. It follows the following principles:
- **Separate repositories:** The project, the API and the client live in separate repositories.
- **API-driven development:** Separation of client (static files) and server (API).
- **Single entity definition:** Entities (and thus API endpoints) are the same on both the server and the client, including validation.
## Installation
1. Install swan and the other dependencies: `npm i -g sails jspm gulp swan-cli`
2. Create a [personal access token](https://github.com/settings/tokens) on github and set permissions for `repo`.
3. Type `swan configure` and follow the steps.
4. Enjoy!
## Usage
Usage is described in the `swan --help` output.
#### New project
To create a new project.
```
swan new projectname
```
#### Configuring project
Configure default settings such as personal access token and protocols (ssh/https). Switching protocols in a swan project will update all the remotes.
```
swan configure
```
#### Collaborate on existing project
To start working on, or check out a project.
```
swan setup owner/repository
```
For instance `swan setup spoonx/aurelia-todo`.
#### Start your project
Start your project. This starts both the server, and the client in one convenient command.
```
swan start --v
```
## Configuration
Swan can be configured by changing the contents of the `swan.json` file.
## Coming soon(ish)
* Getting started
* Swan install (to quickly set up your project after cloning).
* Support for mobile.
## Disclaimer
This project is a little bit messy. It's relatively easy to get into, but it could be structured much better.
This is the first version, meant as a PoC to figure out what works best for SWAN.
This means it _will_ be refactored at some point, but the usage will most likely stay the same.