26 lines
873 B
Markdown
26 lines
873 B
Markdown
# Example GraphQL API
|
|
|
|
An example GraphQL API using:
|
|
|
|
- [`koa`](https://npm.im/koa)
|
|
- [`apollo-server-koa`](https://npm.im/apollo-server-koa)
|
|
- [`graphql-upload`](https://npm.im/graphql-upload)
|
|
|
|
## Setup
|
|
|
|
1. Install the latest [Node.js and npm](https://npmjs.com/get-npm).
|
|
2. Duplicate `.env.example` as `.env` and configure.
|
|
3. Run `npm install` in the `api` directory with Terminal.
|
|
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): [`linter-eslint`](https://atom.io/packages/linter-eslint).
|
|
- [VS Code](https://code.visualstudio.com): [`vscode-eslint`](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
|
|
|
|
## Support
|
|
|
|
See `package.json` `engines`.
|