2017-10-02 16:51:21 +11:00

26 lines
892 B
Markdown

![Apollo upload logo](../apollo-upload-logo.svg)
# Apollo upload example API
An example GraphQL API using:
- [koa](https://www.npmjs.com/package/koa)
- [graphql-server-koa](https://www.npmjs.com/package/graphql-server-koa)
- [apollo-upload-server](https://www.npmjs.com/package/apollo-upload-server)
## Setup
1. Install the latest [Node.js](https://nodejs.org) and [npm](https://npmjs.com).
2. Duplicate `.env.example` as `.env` and customize.
3. With Terminal in the `api` directory run `npm install`.
4. Run `npm run dev` for development, or `npm run start` for production.
Ensure your editor supports:
- [EditorConfig](http://editorconfig.org).
- [ESLint](http://eslint.org), respecting `package.json` config. [Atom](https://atom.io) users install [`linter-eslint`](https://atom.io/packages/linter-eslint) and enable `Fix errors on save`.
## Support
See `package.json` `engines`.