# eggjs-realworld-example-app

**Repository Path**: shanejix/eggjs-realworld-example-app

## Basic Information

- **Project Name**: eggjs-realworld-example-app
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-11-09
- **Last Updated**: 2024-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Egg.js RealWorld Example App

[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]

[travis-image]: https://img.shields.io/travis/eggjs-community/eggjs-realworld-example-app.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs-community/eggjs-realworld-example-app
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs-community/eggjs-realworld-example-app.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/eggjs-community/eggjs-realworld-example-app
[david-image]: https://img.shields.io/david/eggjs-community/eggjs-realworld-example-app.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs-community/eggjs-realworld-example-app

> ### Example Node (Eggjs + Mysql) codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) API spec.

This repo is working — PRs and issues welcome!

## QuickStart

<!-- add docs here for user -->

see [egg docs][egg] for more detail.

### Development

```bash
$ npm i
$ npm run migrate:up // create db first
$ npm run dev
$ open http://localhost:7001/
```

### Deploy

```bash
$ npm start
$ npm stop
```

### npm scripts

* Use `npm run lint` to check code style.
* Use `npm test` to run unit test.
* Use `npm run autod` to auto detect dependencies upgrade, see [autod](https://www.npmjs.com/package/autod) for more detail.

[egg]: https://eggjs.org

## Links

* [RealWorld API Spec](https://github.com/gothinkster/realworld/tree/master/api)

* [vue-realworld-example-app](https://vue-vuex-realworld.netlify.com/)

* [react-dva-realworld-example-app](https://github.com/sinchang/react-dva-realworld-example-app)

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore -->
| [<img src="https://avatars0.githubusercontent.com/u/3297859?v=4" width="100px;"/><br /><sub><b>sinchang</b></sub>](https://buymeacoff.ee/sinchang)<br />[💻](https://github.com/eggjs-community/eggjs-realworld-example-app/commits?author=sinchang "Code") [🚇](#infra-sinchang "Infrastructure (Hosting, Build-Tools, etc)") | [<img src="https://avatars1.githubusercontent.com/u/18510448?v=4" width="100px;"/><br /><sub><b>sfyr111</b></sub>](https://github.com/sfyr111)<br />[💻](https://github.com/eggjs-community/eggjs-realworld-example-app/commits?author=sfyr111 "Code") |
| :---: | :---: |

<!-- ALL-CONTRIBUTORS-LIST:END -->

Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<!-- prettier-ignore -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!