25 lines
684 B
Markdown
25 lines
684 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)
|
|
|
|
## Installation
|
|
|
|
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](https://editorconfig.org)
|
|
- [ESLint](https://eslint.org)
|
|
- [Prettier](https://prettier.io)
|
|
|
|
## Requirements
|
|
|
|
See the [`package.json`](./package.json) field `engines`.
|