Skip to content

Commit c2ed34a

Browse files
authored
Fully automate learner setup with Gitpod (epicweb-dev#260)
1 parent d47b11c commit c2ed34a

File tree

3 files changed

+45
-6
lines changed

3 files changed

+45
-6
lines changed

.gitpod.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
tasks:
2+
- name: App
3+
init: npm install
4+
command: npm run start
5+
openMode: split-left
6+
7+
- name: Test
8+
command: npm run test
9+
openMode: split-right
10+
11+
- name: Set up email
12+
command: |
13+
clear
14+
printf "\n\n\n"
15+
printf "\u001b[36;1mAutofilling Email\u001b[0m\n"
16+
printf "\u001b[2;1mEach exercise comes with a elaboration form to help your retention. Providing your email now will mean you don't have to provide it each time you fill out the form.\u001b[0m\n"
17+
18+
npx "https://gist.github.com/kentcdodds/2d44448a8997b9964b1be44cd294d1f5" \
19+
&& exit 0
20+
21+
vscode:
22+
extensions:
23+
- VisualStudioExptTeam.vscodeintellicode
24+
- dbaeumer.vscode-eslint
25+
- formulahendry.auto-rename-tag
26+
- esbenp.prettier-vscode
27+
- ms-azuretools.vscode-docker

.vscode/settings.kcd.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@
5454
},
5555
"workbench.colorTheme": "Night Owl",
5656
"workbench.iconTheme": "material-icon-theme",
57+
"workbench.editorAssociations": {
58+
"*.md": "vscode.markdown.preview.editor"
59+
},
5760
"breadcrumbs.enabled": true,
5861
"grunt.autoDetect": "off",
5962
"gulp.autoDetect": "off",

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
[![GPL 3.0 License][license-badge]][license]
2626
[![All Contributors][all-contributors-badge]](#contributors-)
2727
[![Code of Conduct][coc-badge]][coc]
28+
[![Gitpod ready-to-code][gitpod-badge]](https://gitpod.io/#https://github.com/kentcdodds/react-fundamentals)
2829
<!-- prettier-ignore-end -->
2930

3031
## Prerequisites
@@ -40,6 +41,19 @@
4041
> material in this repo has been updated to React version ^18. Differences are
4142
> minor and any relevant differences are noted in the instructions.
4243
44+
## Quick start
45+
46+
It's recommended you run everything in the same environment you work in every
47+
day, but if you don't want to set up the repository locally, you can get started
48+
in one click with [Gitpod](https://gitpod.io),
49+
[CodeSandbox](https://codesandbox.io/s/github/kentcdodds/react-fundamentals), or
50+
by following the [video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)
51+
instructions for [GitHub Codespaces](https://github.com/features/codespaces).
52+
53+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/kentcdodds/react-fundamentals)
54+
55+
For a local development environment, follow the instructions below
56+
4357
## System Requirements
4458

4559
- [git][git] v2.13 or greater
@@ -102,12 +116,6 @@ setup the project with the following command:
102116
docker-compose up
103117
```
104118

105-
It's recommended you run everything locally in the same environment you work in
106-
every day, but if you're having issues getting things set up, you can also set
107-
this up using [GitHub Codespaces](https://github.com/features/codespaces)
108-
([video demo](https://www.youtube.com/watch?v=gCoVJm3hGk4)) or
109-
[Codesandbox](https://codesandbox.io/s/github/kentcdodds/react-fundamentals).
110-
111119
## Running the app
112120

113121
To get the app up and running (and really see if it worked), run:
@@ -277,6 +285,7 @@ Thank you! https://kcd.im/rf-ws-feedback
277285
[license-badge]: https://img.shields.io/badge/license-GPL%203.0%20License-blue.svg?style=flat-square
278286
[license]: https://github.com/kentcdodds/react-fundamentals/blob/main/LICENSE
279287
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
288+
[gitpod-badge]: https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod
280289
[coc]: https://github.com/kentcdodds/react-fundamentals/blob/main/CODE_OF_CONDUCT.md
281290
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
282291
[all-contributors]: https://github.com/kentcdodds/all-contributors

0 commit comments

Comments
 (0)