jos3duardo/upload-apollo-client
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme improvements.

Browse Source
This commit is contained in:
Jayden Seric 2017-10-02 16:51:21 +11:00
parent 3950125dae
commit 8d5eb3ec11
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api/readme.md
View File

@ -15,7 +15,10 @@ An example GraphQL API using:
3. With Terminal in the `api` directory run `npm install`. 3. With Terminal in the `api` directory run `npm install`.
4. Run `npm run dev` for development, or `npm run start` for production. 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 ## Support

12
app/readme.md
View File

@ -12,13 +12,15 @@ An example SSR web app using:
## Setup ## Setup
1. Install the latest [Node.js](https://nodejs.org) and [npm](https://npmjs.com). 1. Install the latest [Node.js](https://nodejs.org) and [npm](https://npmjs.com).
2. Run `npm install` within the `app` directory in Terminal. 2. Duplicate `.env.example` as `.env` and customize.
3. Copy `.env.example`, rename it `.env` and customize. 3. With Terminal in the `api` directory run `npm install`.
4. Run `npm run dev` for development, or `npm run build && npm run start` for production.
For development run `npm run dev`. Ensure your editor supports:
For production run `npm run build && npm run start`. - [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 ## Support
See `engines` in `package.json`. See `package.json` `engines`.