Readme tweaks and fixes.

This commit is contained in:
Jayden Seric 2017-11-08 15:07:41 +11:00
parent e38833bbc0
commit d913f91f1e
2 changed files with 16 additions and 16 deletions

View File

@ -4,16 +4,16 @@
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)
* [koa](https://npm.im/koa)
* [graphql-server-koa](https://npm.im/graphql-server-koa)
* [apollo-upload-server](https://npm.im/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`.
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:

View File

@ -2,11 +2,12 @@
# Apollo upload examples
![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)
![Github issues](https://img.shields.io/github/issues/jaydenseric/apollo-upload-examples.svg?style=flat-square)
![Github stars](https://img.shields.io/github/stars/jaydenseric/apollo-upload-examples.svg?style=flat-square)
![License](https://img.shields.io/badge/license-MIT-blue.svg)
[![Github issues](https://img.shields.io/github/issues/jaydenseric/apollo-upload-examples.svg)](https://github.com/jaydenseric/apollo-upload-examples/issues)
[![Github stars](https://img.shields.io/github/stars/jaydenseric/apollo-upload-examples.svg)](https://github.com/jaydenseric/apollo-upload-examples/stargazers)
A full stack demo of file uploads via GraphQL mutations with [Apollo](http://dev.apollodata.com).
A full stack demo of file uploads via GraphQL mutations with
[Apollo](https://apollographql.com).
## GraphQL API
@ -14,9 +15,9 @@ See [`api/readme.md`](api/readme.md).
Uses:
- [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)
* [koa](https://npm.im/koa)
* [graphql-server-koa](https://npm.im/graphql-server-koa)
* [apollo-upload-server](https://npm.im/apollo-upload-server)
## Web app
@ -24,7 +25,6 @@ See [`app/readme.md`](app/readme.md).
Uses:
- [next](https://www.npmjs.com/package/next)
- [react-apollo](https://www.npmjs.com/package/react-apollo)
- [apollo-link-batch-http](https://www.npmjs.com/package/apollo-link-batch-http)
- [apollo-fetch-upload](https://www.npmjs.com/package/apollo-fetch-upload)
* [next](https://npm.im/next)
* [react-apollo](https://npm.im/react-apollo)
* [apollo-upload-client](https://npm.im/apollo-upload-client)