Skip to content

Add getting started React #436

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 23 commits into from
Oct 11, 2019
Merged

Add getting started React #436

merged 23 commits into from
Oct 11, 2019

Conversation

berthieresteban
Copy link
Contributor

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
Copy link

codecov bot 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
Copy link

codecov bot commented Aug 1, 2019 •
edited
Loading

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
Copy link
Contributor

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

@berthieresteban
Copy link
Contributor Author

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
Copy link
Contributor

Aschen commented Aug 1, 2019

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

@Aschen
Copy link
Contributor

Aschen 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 changed the base branch from 6-dev to master August 16, 2019 13:42
Aschen
Aschen suggested changes Aug 19, 2019
View reviewed changes
@berthieresteban @Aschen
Apply suggestions from code review
e41e590 
Co-Authored-By: Adrien Maret <amaret93@gmail.com>
@berthieresteban berthieresteban requested a review from Aschen August 27, 2019 07:53
benoitvidis
benoitvidis approved these changes Aug 29, 2019
View reviewed changes
Copy link
Contributor

@benoitvidis benoitvidis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provided cypress tests are fixed

@berthieresteban
Copy link
Contributor Author

Travis deadlinks fails are fixed in this PR

@scottinet
Copy link
Contributor

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 self-assigned this Oct 3, 2019
@scottinet scottinet merged commit 316cd5e into master Oct 11, 2019
@scottinet scottinet deleted the add-gs-react branch October 11, 2019 13:37
scottinet pushed a commit that referenced this pull request Oct 11, 2019
@berthieresteban @scottinet
Add getting started React (#436)
e8e77d2 
## 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
/
@scottinet scottinet mentioned this pull request Oct 11, 2019
Merged
Aschen pushed a commit that referenced this pull request Oct 15, 2019
@scottinet @Aschen
Import Vue.js and React getting started from v6 (#454)
00bf113 
# Description

Import #431 and #436 to v7: commits were cherry-picked, then the getting started directories were moved to the `doc/7` documentation directory. Finally, the `test-doc` script has been adapted to run tests on the v7 version of the getting started.

Those are the only changes made, there should be no need to review the full content of this PR (but you may do it if you want to)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

3 more reviewers

@Aschen Aschen Aschen approved these changes

@benoitvidis benoitvidis benoitvidis approved these changes

@scottinet scottinet scottinet approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@xbill82 xbill82

@berthieresteban berthieresteban

Labels

6-dev changelog:exclude

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@berthieresteban @Yoann-Abbes @Aschen @scottinet @benoitvidis @xbill82