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

Add getting started React #436

Merged
merged 23 commits into from Oct 11, 2019

Conversation

@berthieresteban
Copy link
Contributor

commented Aug 1, 2019

What does this PR do?

Add Kuzzle React getting-started.

This getting-started have been merge in the last doc #291

The last getting started app was builted progressively and some code was rewrite during the reading.
I had to rewrite lot of parts to remove that because it implicated some untested lines. I avoid hard snippets written in the readme too.

I removed the tested snippets and add cypress to test the app globally.

The app use the current 6-dev sdk version with the ugly post-install line in doc/6/getting-started/.react/package.json

How should this be manually tested?

  • Step 0 : Kuzzle running stack
  • Step 1 : cd doc/6/getting-started/.react
  • Step 2 : yarn install
  • Step 3 : yarn start & (if error add SKIP_PREFLIGHT_CHECK=true)
  • Step 4 : npm run test

Other changes

/

Boyscout

/

@berthieresteban berthieresteban self-assigned this Aug 1, 2019
@berthieresteban berthieresteban changed the title Add gs react Add getting started React Aug 1, 2019
@codecov

This comment has been minimized.

Copy link

commented Aug 1, 2019

Codecov Report

Merging #436 into 6-dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##            6-dev     #436   +/-   ##
=======================================
  Coverage   96.15%   96.15%           
=======================================
  Files          33       33           
  Lines        1612     1612           
=======================================
  Hits         1550     1550           
  Misses         62       62

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 57d6342...2f864b6. Read the comment docs.

@codecov

This comment has been minimized.

Copy link

commented Aug 1, 2019

Codecov Report

Merging #436 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #436   +/-   ##
=======================================
  Coverage   96.03%   96.03%           
=======================================
  Files          33       33           
  Lines        1641     1641           
=======================================
  Hits         1576     1576           
  Misses         65       65

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6ef99ba...ad06191. Read the comment docs.

@Yoann-Abbes

This comment has been minimized.

Copy link
Contributor

commented Aug 1, 2019

Why is there a react folder and a .react one ?

@berthieresteban

This comment has been minimized.

Copy link
Contributor Author

commented Aug 1, 2019

The react folder contains the readme wich is used to build the doc and the .react folder contains the react app wich will be build an tested in it's own environment. This "architecture" follow the same we decided to user for the Vuejs getting-started :)

@Aschen

This comment has been minimized.

Copy link
Contributor

commented Aug 1, 2019

This PR should be on the master branch since it's not a new feature that is documented

@Aschen

This comment has been minimized.

Copy link
Contributor

commented Aug 6, 2019

And I think you should do as for your Vue.js getting started: having a submenu with this "React Redux" getting started so in the futur we can have another one with only "React"

@berthieresteban berthieresteban added the wip label Aug 7, 2019
@berthieresteban berthieresteban changed the base branch from 6-dev to master Aug 16, 2019
@berthieresteban berthieresteban removed the wip label Aug 16, 2019
doc/6/getting-started/react/with-redux/index.md Outdated Show resolved Hide resolved
doc/6/getting-started/react/with-redux/index.md Outdated Show resolved Hide resolved
doc/6/getting-started/react/with-redux/index.md Outdated Show resolved Hide resolved
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
@berthieresteban berthieresteban requested a review from Aschen Aug 27, 2019
@Aschen
Aschen approved these changes Aug 27, 2019
Copy link
Member

left a comment

Provided cypress tests are fixed

@berthieresteban berthieresteban added the wip label Aug 29, 2019
@berthieresteban berthieresteban removed the wip label Sep 2, 2019
@berthieresteban berthieresteban requested a review from scottinet Sep 2, 2019
@berthieresteban

This comment has been minimized.

Copy link
Contributor Author

commented Sep 6, 2019

Travis deadlinks fails are fixed in this PR

@scottinet

This comment has been minimized.

Copy link
Member

commented Sep 9, 2019

Cypress tests are still failing.

@xbill82 xbill82 added the wip label Sep 10, 2019
@xbill82 xbill82 assigned xbill82 and unassigned berthieresteban Sep 10, 2019
@berthieresteban berthieresteban removed the wip label Oct 3, 2019
@berthieresteban berthieresteban self-assigned this Oct 3, 2019
@scottinet scottinet merged commit 316cd5e into master Oct 11, 2019
5 of 8 checks passed
5 of 8 checks passed
Header rules No header rules processed
Details
Pages changed 373 new files uploaded
Details
Redirect rules No redirect rules processed
Details
LGTM analysis: JavaScript No new or fixed alerts
Details
Mixed content No mixed content detected
Details
codecov/project 96.03% remains the same compared to 6ef99ba
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
deploy/netlify Deploy preview ready!
Details
@scottinet scottinet deleted the add-gs-react branch Oct 11, 2019
scottinet added a commit that referenced this pull request Oct 11, 2019
## What does this PR do?
Add Kuzzle React getting-started.

This getting-started have been merge in the last doc [#291](kuzzleio/documentation#291)

The last getting started app was builted progressively and some code was rewrite during the reading. 
I had to rewrite lot of parts to remove that because it implicated some untested lines. I avoid hard snippets written in the readme too.

I removed the tested snippets and add cypress to test the app globally.

The app use the current 6-dev sdk version with the ugly post-install line in `doc/6/getting-started/.react/package.json`

### How should this be manually tested?

  - Step 0 : Kuzzle running stack
  - Step 1 : cd doc/6/getting-started/.react
  - Step 2 : yarn install
  - Step 3 : yarn start &  (if error add `SKIP_PREFLIGHT_CHECK=true`)
  - Step 4 : npm run test

### Other changes
/

### Boyscout
/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.