-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
jjurman
committed
Sep 10, 2017
1 parent
d8976fc
commit 930ab4d
Showing
4 changed files
with
41 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Tram-One Express | ||
|
||
Tram-One Express is a generator for building tram-one applications. | ||
|
||
## Usage | ||
To use tram-one-express, install using npm, and then run the command with the name of the app you want to build: | ||
``` | ||
$ npm install -g tram-one-express | ||
$ tram-one-express app-name | ||
``` | ||
This will create a directory in your current directory with the name that you pass into tram-one-express. | ||
|
||
## What's in the box | ||
Below are a list of files and directories that are created after running tram-one-express | ||
``` | ||
app-name/ | ||
├── README.md | ||
├── elements | ||
│ └── header.js | ||
├── main.js | ||
├── package.json | ||
├── pages | ||
│ ├── 404.js | ||
│ └── home.js | ||
├── public | ||
│ ├── favicon.png | ||
│ └── index.html | ||
└── specs | ||
├── header-spec.js | ||
├── specs.js | ||
├── testem.html | ||
└── testem.yml | ||
``` | ||
|
||
## Developement Commands | ||
Below are a list of commands used for developement. The logic for all the commands are in the local `package.json` | ||
- `npm start` - creates an example app `tram-one-example` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,9 @@ | ||
# Distributable | ||
dist | ||
|
||
# Files built when testing | ||
specs/spec-bundle.js | ||
|
||
# Logs | ||
logs | ||
*.log | ||
|
Oops, something went wrong.