Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TRACKING: master → feature/apollo-pure #1666

Closed
wants to merge 44 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
a1dc543
Pure Apollo integration based on `master`
piglovesyou Aug 7, 2018
b1b784d
Merge branch 'master' into feature/apollo-pure
langpavel Sep 4, 2018
12760a0
Add features to feature/apollo-pure (#1714)
piglovesyou Feb 19, 2019
000a954
Improve feature/apollo-pure (#1720)
piglovesyou Mar 21, 2019
27035c7
Use TypeScript and other improvements on feature/apollo-pure (#1723)
piglovesyou May 27, 2019
89f5697
Use GraphQL Code Generator for codegen and other improvements (#1734)
piglovesyou Jun 21, 2019
5004cdf
Merge master branch (#1746)
piglovesyou Sep 1, 2019
a57cc08
Describe `yarn codegen` in docs.
piglovesyou Sep 1, 2019
09afe1d
Merge remote-tracking branch 'upstream/master' into feature/apollo-pure
piglovesyou Sep 1, 2019
ebf730f
Update all dependencies (#1747)
piglovesyou Sep 1, 2019
05ed238
Merge remote-tracking branch 'upstream/master' into feature/apollo-pure
piglovesyou Sep 1, 2019
d738451
Update apollo pure (#1762)
piglovesyou Nov 2, 2019
c86ffdd
Use double quotes in the npm script lines for supporting windows (#1804)
piglovesyou Nov 11, 2019
5d10866
chore(deps-dev): bump file-loader from 4.2.0 to 5.0.2 (#1840)
dependabot-preview[bot] Nov 25, 2019
4acb8b1
chore(deps-dev): bump @babel/preset-typescript from 7.6.0 to 7.7.4 (#…
dependabot-preview[bot] Nov 25, 2019
270f395
Include job test (#1845)
piglovesyou Nov 25, 2019
ead7452
chore(deps-dev): bump @typescript-eslint/eslint-plugin (#1846)
dependabot-preview[bot] Nov 25, 2019
02ab033
chore(deps-dev): bump stylelint from 11.1.1 to 12.0.0 (#1850)
dependabot-preview[bot] Nov 25, 2019
57bcc7e
chore(deps-dev): bump raw-loader from 3.1.0 to 4.0.0 (#1848)
dependabot-preview[bot] Nov 25, 2019
073c77e
chore(deps-dev): bump typescript from 3.6.4 to 3.7.2 (#1847)
dependabot-preview[bot] Nov 25, 2019
8def547
chore(deps-dev): bump @typescript-eslint/parser from 2.8.0 to 2.9.0 (…
dependabot-preview[bot] Nov 25, 2019
80f7187
chore(deps-dev): bump url-loader from 2.3.0 to 3.0.0 (#1852)
dependabot-preview[bot] Nov 27, 2019
3b4384e
chore(deps-dev): bump eslint-plugin-jest from 23.0.4 to 23.0.5 (#1853)
dependabot-preview[bot] Nov 27, 2019
d1ea30d
chore(deps-dev): bump @graphql-codegen/typescript-operations (#1856)
dependabot-preview[bot] Dec 5, 2019
24c9546
chore(deps-dev): bump @types/react from 16.9.13 to 16.9.15 (#1858)
dependabot-preview[bot] Dec 5, 2019
7e3bbe4
chore(deps-dev): bump @typescript-eslint/eslint-plugin (#1857)
dependabot-preview[bot] Dec 5, 2019
1c808f5
chore(deps-dev): bump react-error-overlay from 6.0.3 to 6.0.4 (#1859)
dependabot-preview[bot] Dec 5, 2019
023fc9a
chore(deps-dev): bump jest-codemods from 0.22.0 to 0.22.1 (#1861)
dependabot-preview[bot] Dec 5, 2019
3c77950
chore(deps-dev): bump eslint-plugin-react from 7.16.0 to 7.17.0 (#1862)
dependabot-preview[bot] Dec 5, 2019
3419344
chore(deps): [security] bump serialize-javascript from 2.1.0 to 2.1.1…
dependabot-preview[bot] Dec 5, 2019
a3474d0
chore(deps-dev): bump @graphql-codegen/cli from 1.8.3 to 1.9.1 (#1860)
dependabot-preview[bot] Dec 5, 2019
0a7efb6
chore(deps-dev): bump lint-staged from 9.4.3 to 9.5.0 (#1864)
dependabot-preview[bot] Dec 5, 2019
ed08c5a
chore(deps-dev): bump typescript from 3.7.2 to 3.7.3 (#1863)
dependabot-preview[bot] Dec 6, 2019
0d0332b
chore(deps): [security] bump acorn from 5.7.3 to 5.7.4 (#1879)
dependabot-preview[bot] Mar 14, 2020
691f7bd
chore(deps): [security] bump apollo-server-core from 2.9.12 to 2.14.4…
dependabot-preview[bot] Jun 15, 2020
8f85b86
chore(deps): [security] bump websocket-extensions from 0.1.3 to 0.1.4…
dependabot-preview[bot] Jun 15, 2020
483099a
Merge pull request #1895
dependabot-preview[bot] Jun 15, 2020
b99cc47
Merge pull request #1888
dependabot-preview[bot] Jun 15, 2020
92e938c
chore(deps): [security] bump apollo-server from 2.9.12 to 2.14.2 (#1894)
dependabot-preview[bot] Jun 15, 2020
4e71443
chore(deps): [security] bump elliptic from 6.5.2 to 6.5.3 (#1907)
dependabot-preview[bot] Jul 30, 2020
40ab5eb
chore(deps): [security] bump serialize-javascript from 2.1.1 to 3.1.0…
dependabot-preview[bot] Aug 12, 2020
b2284c8
chore(deps): [security] bump node-fetch from 2.6.0 to 2.6.1 (#1912)
dependabot-preview[bot] Sep 11, 2020
f7800b5
chore(deps): [security] bump dot-prop from 4.2.0 to 4.2.1 (#1918)
dependabot-preview[bot] Nov 2, 2020
6b789a7
chore(deps): [security] bump ini from 1.3.5 to 1.3.7 (#1926)
dependabot-preview[bot] Dec 10, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Describe yarn codegen in docs.
piglovesyou committed Sep 1, 2019

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
commit a57cc08bf0cc6b12c46de57cbef7faa29718e57c
43 changes: 24 additions & 19 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -22,23 +22,23 @@ Before you start, take a moment to see how the project structure looks like:
│ ├── /components/ # React components
│ ├── /data/ # GraphQL server schema and data models
│ ├── /routes/ # Page/screen components along with the routing information
│ ├── /client.js # Client-side startup script
│ ├── /config.js # Global application settings
│ ├── /server.js # Server-side startup script
│ ├── /client.ts # Client-side startup script
│ ├── /config.ts # Global application settings
│ ├── /server.ts # Server-side startup script
│ └── ... # Other core framework modules
├── /test/ # Unit and end-to-end tests
├── /tools/ # Build automation scripts and utilities
│ ├── /lib/ # Library for utility snippets
│ ├── /build.js # Builds the project from source to output (build) folder
│ ├── /bundle.js # Bundles the web resources into package(s) through Webpack
│ ├── /clean.js # Cleans up the output (build) folder
│ ├── /copy.js # Copies static files to output (build) folder
│ ├── /deploy.js # Deploys your web application
│ ├── /postcss.config.js # Configuration for transforming styles with PostCSS plugins
│ ├── /run.js # Helper function for running build automation tasks
│ ├── /runServer.js # Launches (or restarts) Node.js server
│ ├── /start.js # Launches the development web server with "live reload"
│ └── /webpack.config.js # Configurations for client-side and server-side bundles
│ ├── /build.ts # Builds the project from source to output (build) folder
│ ├── /bundle.ts # Bundles the web resources into package(s) through Webpack
│ ├── /clean.ts # Cleans up the output (build) folder
│ ├── /copy.ts # Copies static files to output (build) folder
│ ├── /deploy.ts # Deploys your web application
│ ├── /postcss.config.ts # Configuration for transforming styles with PostCSS plugins
│ ├── /run.ts # Helper function for running build automation tasks
│ ├── /runServer.ts # Launches (or restarts) Node.js server
│ ├── /start.ts # Launches the development web server with "live reload"
│ └── /webpack.config.ts # Configurations for client-side and server-side bundles
├── Dockerfile # Commands for building a Docker image for production
├── package.json # The list of 3rd party libraries and utilities
└── yarn.lock # Fixed versions of all the dependencies
@@ -66,16 +66,21 @@ or by using
This will install both run-time project dependencies and developer tools listed
in [package.json](../package.json) file.

#### 3. Run `yarn codegen`

`feature/apollo-pure` branch TypeScript code generation by [GraphQL Codegen](https://github.com/dotansimha/graphql-code-generator).
Every time you change GraphQL Schema, you need to run `yarn codegen` to make use of the types and data binding functions.

#### 3. Run `yarn start`

This command will build the app from the source files (`/src`) into the output
`/build` folder. As soon as the initial build completes, it will start the
Node.js server (`node build/server.js`) and
Node.js server (`node build/server.ts`) and
[Browsersync](https://browsersync.io/) with
[HMR](https://webpack.github.io/docs/hot-module-replacement) on top of it.

> [http://localhost:3000/](http://localhost:3000/) — Node.js server
> (`build/server.js`) with Browsersync and HMR enabled\
> (`build/server.ts`) with Browsersync and HMR enabled\
> [http://localhost:3000/graphql](http://localhost:3000/graphql) — GraphQL server
> and IDE\
> [http://localhost:3001/](http://localhost:3001/) — Browsersync control panel
@@ -123,7 +128,7 @@ _NOTE: double dashes are required_

After running this command, the `/build` folder will contain the compiled
version of the app. For example, you can launch Node.js server normally by
running `node build/server.js`.
running `node build/server.ts`.

To check the source code for syntax errors and potential issues run:

@@ -139,16 +144,16 @@ $ yarn run test:watch # Launch unit test runner and start watching for change
```

By default, [Jest](https://jestjs.io/) test runner is looking for test files
matching the `src/**/*.test.js` pattern. Take a look at
`src/components/Layout/Layout.test.js` as an example.
matching the `src/**/*.test.ts` pattern. Take a look at
`src/components/Layout/Layout.test.ts` as an example.

To deploy the app, run:

```shell
$ yarn run deploy
```

The deployment script `tools/deploy.js` is configured to push the contents of
The deployment script `tools/deploy.ts` is configured to push the contents of
the `/build` folder to a remote server via Git. You can easily deploy your app
to
[Azure Web Apps](https://azure.microsoft.com/en-us/services/app-service/web/),