πŸ‚ Generator to build Tram-One applications quickly
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
template
tests
.gitignore
README.md
generator.js
package-lock.json
package.json
superstatic.json

README.md

Downloads Version License

Tram-One Express

Tram-One Express is a generator for building tram-one applications.

Usage

To use tram-one-express, run using npx, and pass the app-name of what project you want to create:

$ npx 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 run generate-example - alias for example-generate
  • npm run example-generate - creates an example app and installs dependencies in the example
  • npm run example-build - runs npm run build in the example project
  • npm run example-start - runs the start script, which kicks off a webpack server
  • npm run example-start-and-kill - runs the webpack dev server, and then runs jasmine tests against the server (verifying that the default pages load correctly, and without any errors)
  • npm run example-check - verifies default pages load correctly for a running instance of the example app (used in example-start-and-kill)
  • npm run example-test - runs the test suite for the example app
  • example-browser-test - runs tests for all locally available browsers, making sure that tram-one is able to render correctly for each one
  • ci-run - runs all the commands in the order that circleci would trigger them, one automatically after the other