Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eggjs/examples

Store all egg examples in one place
https://github.com/eggjs/examples

egg example showcase

Last synced: about 2 months ago
JSON representation

Store all egg examples in one place

Awesome Lists containing this project

README

        

# Examples for [egg](https://github.com/eggjs/egg)

---

[![build status][travis-image]][travis-url]
[![node version][node-image]][node-url]
[![egg version][egg-image]][egg-url]

[travis-image]: https://img.shields.io/travis/eggjs/examples.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/examples
[node-image]: https://img.shields.io/badge/node.js-%3E=_8-green.svg?style=flat-square
[node-url]: http://nodejs.org/download/
[egg-image]: https://img.shields.io/badge/egg-%3E=_1-green.svg?style=flat-square
[egg-url]: https://github.com/eggjs/egg

## Usage

Find the example, then run command below. For example, run the [hackernews-datahub](https://github.com/eggjs/examples/tree/master/hackernews-datahub) example:

```bash
$ cd hackernews-datahub
$ npm install
$ npm run dev
```

**Recommend to use Node >= 8**

## List of examples

- [cnode-api](https://github.com/eggjs/examples/tree/master/cnode-api)
- [cookie-session](https://github.com/eggjs/examples/tree/master/cookie-session)
- [cookie](https://github.com/eggjs/examples/tree/master/cookie)
- [custom-env](https://github.com/eggjs/examples/tree/master/custom-env)
- [download](https://github.com/eggjs/examples/tree/master/download)
- [framework](https://github.com/eggjs/examples/tree/master/framework)
- [hackernews-async-ts](https://github.com/eggjs/examples/tree/master/hackernews-async-ts)
- [hackernews](https://github.com/eggjs/examples/tree/master/hackernews)
- [hackernews-datahub](https://github.com/eggjs/examples/tree/master/hackernews-datahub)
- [helloworld](https://github.com/eggjs/examples/tree/master/helloworld)
- [httpclient](https://github.com/eggjs/examples/tree/master/httpclient)
- [ipc](https://github.com/eggjs/examples/tree/master/ipc)
- [middleware](https://github.com/eggjs/examples/tree/master/middleware)
- [multipart](https://github.com/eggjs/examples/tree/master/multipart)
- [passport](https://github.com/eggjs/examples/tree/master/passport)
- [progressive](https://github.com/eggjs/examples/tree/master/progressive)
- [redefine-controller](https://github.com/eggjs/examples/tree/master/redefine-controller)
- [schedule](https://github.com/eggjs/examples/tree/master/schedule)
- [sequelize-example](https://github.com/eggjs/examples/tree/master/sequelize)
- [static](https://github.com/eggjs/examples/tree/master/static)
- [unittest](https://github.com/eggjs/examples/tree/master/unittest)
- [view-nunjucks](https://github.com/eggjs/examples/tree/master/view-nunjucks)

## Development

### Run test

```bash
$ npm test
```

You can use `--verbose` to show more infomation

```bash
$ npm test -- --verbose
```

### Generate dependencies

```bash
$ npm run autod
```

### Show list of examples

```bash
$ npm run list
```