These are the tools you will need to build and run pybricks-code locally.
Technically you can use any text editor you like but the project is set up to use VS Code. The project includes some recommended extensions that will do nice things like automatically format the code for you.
These are the required software tools you need to install on your computer.
We are using Node.js v12.x. We recommend using a tool such as asdf or nvm if you need to install more than one version of Node.js.
We are using Yarn 1.x for package management.
One of the node dependencies needs Python 2 in order to build!
If you see this error, that is what is going on.
You will need Git to get the source code from GitHub. (Say that 3 times fast!)
After the tools above have been installed, open a command prompt in the directory where you would like to save the source code and run:
git clone https://github.com/pybricks/pybricks-code
cd pybricks-code
yarn install
This project was bootstrapped with Create React App.
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
If your default browser is not compatible (i.e. not chromium), create a file
.env.local in the root directory with the full path to the browser:
BROWSER=<path-to-chromium>
The page will reload if you make edits.
You will also see any lint errors in the console.
Runs the code linter.
This will automatically fix most lint errors for you.
See README in the test/ directory.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
WebBluetooth requires https. So to locally test the result of yarn build,
run ./tools/serve.py then point a web browser to https://localhost:8443
(don't leave out https!).
Usually using yarn start is more convenient for local development, but this is
particularly useful for testing changes on an Android device, for example. On
remote devices, replace localhost with the hostname or IP address of the
computer running the ./tools/serve.py script.
This server uses a self-signed certificate, so the browser will complain that the site is not secure. This warning can be ignored by clicking the Advanced button and then click the link to proceed to the site.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
To learn React Redux, check out the React Redux documentation
To learn Redux-Saga, checkout the Redux-Saga documentation