You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-25Lines changed: 27 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,31 @@
1
-
# Getting Started with Create React App
1
+
# Early development version of the next micro:bit Python editor
2
2
3
-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
3
+
This project is a web-based editor that targets the [MicroPython](https://micropython.org) version of the [Python programming language](http://python.org/). Code written with this editor is expected to run on the [BBC micro:bit device](https://microbit.org).
4
4
5
-
## Available Scripts
5
+
**The currently supported micro:bit Python editor is available at https://python.microbit.org/ and its source code can be found in GitHub at https://github.com/bbcmicrobit/PythonEditor.**
6
6
7
-
In the project directory, you can run:
7
+
**This project is an early development version of the next version of the editor.**
8
+
9
+
**It is not yet ready for use.**
10
+
11
+
## Developing the editor
12
+
13
+
The editor is written in TypeScript using React.
14
+
15
+
To learn React, check out the [React documentation](https://reactjs.org/).
16
+
17
+
To learn TypeScript, check out the [TypeScript documentation](https://www.typescriptlang.org/).
18
+
19
+
This early prototype uses the [Chakra UI](https://chakra-ui.com/) component library.
20
+
21
+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
22
+
23
+
## Building and running the editor
24
+
25
+
1. Ensure you have a working Node.js environment. We recommend using the LTS version of Node.
26
+
2. Checkout this repository.
27
+
3. Install the dependencies via `npm install`.
28
+
4. Choose from the NPM scripts documented below.
8
29
9
30
### `npm start`
10
31
@@ -19,28 +40,9 @@ You will also see any lint errors in the console.
19
40
Launches the test runner in the interactive watch mode.\
20
41
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21
42
43
+
If you have a connected micro:bit device then setting the environment variable `TEST_MODE_DEVICE=1` will enable additional tests that will connect to your micro:bit. The tests will overwrite programs and data on the micro:bit.
44
+
22
45
### `npm run build`
23
46
24
47
Builds the app for production to the `build` folder.\
25
48
It correctly bundles React in production mode and optimizes the build for the best performance.
26
-
27
-
The build is minified and the filenames include the hashes.\
28
-
Your app is ready to be deployed!
29
-
30
-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31
-
32
-
### `npm run eject`
33
-
34
-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
35
-
36
-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
37
-
38
-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
39
-
40
-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
41
-
42
-
## Learn More
43
-
44
-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
45
-
46
-
To learn React, check out the [React documentation](https://reactjs.org/).
0 commit comments