https://github.com/witheve/eve-starter
Start here if you're new to Eve.
https://github.com/witheve/eve-starter
Last synced: about 1 year ago
JSON representation
Start here if you're new to Eve.
- Host: GitHub
- URL: https://github.com/witheve/eve-starter
- Owner: witheve
- License: apache-2.0
- Created: 2017-04-03T01:52:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2018-03-20T19:29:42.000Z (over 8 years ago)
- Last Synced: 2025-03-25T19:21:16.646Z (over 1 year ago)
- Language: TypeScript
- Homepage: http://witheve.com
- Size: 342 KB
- Stars: 30
- Watchers: 5
- Forks: 20
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
The Eve Starter is designed to help you hit the ground running with Eve. It includes a number of simple demo programs, a CLI that lets you test Eve programs in node or the browser, and a server that handles most of the frustrations of packaging node modules for the web for you. When you're ready to start building with Eve, you can either modify this framework to suit or just include the runtime into an existing project.
If you're an experienced Eve user looking to include it in your existing app, you can find the runtime at [witheve/eve](https://github.com/witheve/eve).
## Install the Eve v0.3 Preview Starter
First install [Node](https://nodejs.org/en/download/) for your platform.
Then, clone and build the Eve starter repository:
```sh
git clone git@github.com:witheve/eve-starter.git
```
To run the latest stable version:
```sh
cd eve-starter
git checkout release
npm install
```
To run the latest nightly version:
```sh
cd eve-starter
git checkout master
npm install
```
## Using the Starter
If you want to explore the bundled examples you can start the program switcher, which allows you to explore them from your browser. Any `*.eve` files places into the `eve-starter/programs` directory will be shown here.
```sh
npm start
```
Or you can run a specific `.eve` or `.js` program by providing its path as an argument:
```sh
npm start -- path/to/program.js
```
To view other functionality of the starter, run
```sh
npm start -- --help
```