Skip to content

Commit 6deca69

Browse files
author
Anna Aitchison
committed
Add in code for node-challenge-london-mini-guide
1 parent 0b2379c commit 6deca69

23 files changed

Lines changed: 9509 additions & 0 deletions

‎node-challenge-london-mini-guide/CYF-React-Express-Template/.eslintrc.cjs‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
module.exports = {
2+
root: true,
3+
env: { browser: true, es2020: true },
4+
extends: [
5+
'eslint:recommended',
6+
'plugin:react/recommended',
7+
'plugin:react/jsx-runtime',
8+
'plugin:react-hooks/recommended',
9+
],
10+
ignorePatterns: ['dist', '.eslintrc.cjs'],
11+
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
12+
settings: { react: { version: '18.2' } },
13+
plugins: ['react-refresh'],
14+
rules: {
15+
'react-refresh/only-export-components': [
16+
'warn',
17+
{ allowConstantExport: true },
18+
],
19+
},
20+
}

‎node-challenge-london-mini-guide/CYF-React-Express-Template/.gitignore‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
coverage
2+
.DS_Store
3+
# Logs
4+
logs
5+
*.log
6+
npm-debug.log*
7+
yarn-debug.log*
8+
yarn-error.log*
9+
pnpm-debug.log*
10+
lerna-debug.log*
11+
12+
node_modules
13+
dist
14+
dist-ssr
15+
*.local
16+
17+
# Editor directories and files
18+
.vscode/*
19+
!.vscode/extensions.json
20+
.idea
21+
.DS_Store
22+
*.suo
23+
*.ntvs*
24+
*.njsproj
25+
*.sln
26+
*.sw?
27+
/test-results/
28+
/playwright-report/
29+
/blob-report/
30+
/playwright/.cache/
31+
/test-results/
32+
/playwright-report/
33+
/blob-report/
34+
/playwright/.cache/

‎node-challenge-london-mini-guide/CYF-React-Express-Template/.prettierrc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"arrowParens": "always",
3+
"bracketSpacing": true,
4+
"embeddedLanguageFormatting": "auto",
5+
"htmlWhitespaceSensitivity": "css",
6+
"insertPragma": false,
7+
"jsxBracketSameLine": false,
8+
"jsxSingleQuote": false,
9+
"printWidth": 80,
10+
"proseWrap": "preserve",
11+
"quoteProps": "as-needed",
12+
"requirePragma": false,
13+
"semi": true,
14+
"singleQuote": false,
15+
"tabWidth": 2,
16+
"trailingComma": "es5",
17+
"useTabs": false,
18+
"vueIndentScriptAndStyle": false
19+
}

‎node-challenge-london-mini-guide/CYF-React-Express-Template/HOW-TO-GET-HELP.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!--
2+
Do not edit this file.
3+
Make a change to the template and then pull changes
4+
Repo: https://github.com/CodeYourFuture/CYF-Coursework-Template
5+
Update Instructions: https://gist.github.com/ChrisOwen101/84d82f03a60ce19f7f154a7b815fa265
6+
-->
7+
8+
# How To Get Help
9+
10+
Learning to ask good questions is a key skill for a developer and you should practice this every week at CYF. You must spend a lot of time learning how to describe problems clearly and systematically:
11+
12+
https://syllabus.codeyourfuture.io/guides/asking-questions
13+
14+
Problem-solving is the real (marketable) skill of software developers. If you do not have questions to ask about your work, ask for some different work. Don't miss this opportunity to break down challenging problems with a large team of developers.
15+
16+
## Guide
17+
18+
Please review our guide on the Syllabus for how to get help when you are really blocked:
19+
20+
https://syllabus.codeyourfuture.io/guides/escalation-policy/
21+
22+
You should complete all of the steps in the order listed to get help.
23+
24+
## Reporting Issues in Coursework
25+
26+
- Is there a problem with this coursework?
27+
- Have you noticed a bug?
28+
- Is there a typo or a mistake you can help clean up?
29+
30+
Post in the channel named after the module you are working on:
31+
32+
- Git - `cyf-module-git`
33+
- HTML/CSS - `cyf-module-html-css`
34+
- JavaScript Core 1 - `cyf-module-js1`
35+
- JavaScript Core 2 - `cyf-module-js2`
36+
- JavaScript Core 2 - `cyf-module-js3`
37+
- React - `cyf-module-react`
38+
- Node - `cyf-module-node`
39+
- SQL - `cyf-module-sql`
40+
- MongoDB - `cyf-module-mongodb`
41+
42+
Or open an issue directly to the Syllabus. CYF Syllabus is an Open Source project developed on GitHub and you are invited to contribute. Read the Issue Template carefully.
43+
44+
https://github.com/CodeYourFuture/syllabus/issues/new/choose
45+
46+
Still not clear where to share your issue? Post in #cyf-syllabus-tech.

‎node-challenge-london-mini-guide/CYF-React-Express-Template/HOW_TO_REVIEW.md‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
<!--
2+
Do not edit this file.
3+
Make a change to the template and then pull changes
4+
Repo: https://github.com/CodeYourFuture/CYF-Coursework-Template
5+
Update Instructions: https://gist.github.com/ChrisOwen101/84d82f03a60ce19f7f154a7b815fa265
6+
-->
7+
8+
# Everyone reviews code at CYF
9+
10+
Mentors and trainees all review code, and collaborate on improving code quality. We are all helping each other to talk, write, and think about code more clearly.
11+
12+
We are not reviewing code as if we were to merge this PR into production; we are opening a technical conversation for the purpose of insight and development.
13+
14+
## Key points:
15+
16+
1. Ask questions instead of making statements:
17+
18+
**YES:** "Is there another element you could use to group a set of fields in a form? Why might someone use a different element in a form?"
19+
**NO:** "Use fieldset not divs"
20+
21+
2. Encourage simplicity, clarity, and precision:
22+
23+
**YES** "There are 15,0000 files in this changelist. Which files should be reviewed?"
24+
**NO** "It doesn't matter; I can try to figure out what you meant."
25+
26+
3. Respect everyone's work and time:
27+
28+
**YES** "I think there's some more to do here. Thanks for sharing where you're up to."
29+
**NO** "This is rubbish. Try harder."
30+
31+
## Labels
32+
33+
Reviewers, please add labels (provided) to the PR once you've reviewed. This helps to focus the trainee on the areas they should work on, and gives an overview for mentors on what the whole cohort needs to work on.
34+
35+
## Solutions
36+
37+
### Where to find solutions?
38+
39+
You can find the solutions for a module on the `solutions` branch.
40+
41+
### Solutions branch
42+
43+
The solutions branch typically contains:
44+
45+
#### Sample solutions
46+
47+
Solutions are example answers not the only correct answers.
48+
49+
#### Common responses guides.
50+
51+
Everyone is invited to contribute commonly encountered problems, mistakes, misunderstandings, and mental-model errors to our common responses documents.
52+
53+
Use these resources to inform your code review, get unstuck, and improve your understanding.
54+
55+
## Guides
56+
57+
Here's a detailed checklist of the sorts of things we should check code for:
58+
59+
https://syllabus.codeyourfuture.io/guides/marking-guide
60+
61+
Here's a detailed style guide to help us all write clear, high quality code:
62+
63+
https://syllabus.codeyourfuture.io/guides/code-style-guide
64+
65+
Here's some help with giving good feedback during code review:
66+
67+
https://teachertraining.codeyourfuture.io/tasks/code-review

0 commit comments

Comments
 (0)