4.0 KiB
Development Environment
These are the tools you will need to build and run pybricks-code locally.
Important Note about Github Packages
This step is mandatory and cannot be skipped. Otherwise you will have no access to some referenced dependencies in package.json!
We are currently depending on a couple of packages from the Github package registry. Github requires you to log in first before you can install public packages.
To do this, first you will need to create a new authentication token at https://github.com/settings/tokens.
- Click the Generate a new token button.
- Select the repo and read:packages scopes.
- Click the Generate token button.
- Click the clipboard icon top copy the token to be used below.
Then run the following command and enter your username, authentication token and email:
npm login --registry=https://npm.pkg.github.com
This only needs to be done once.
IDE
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.
Toolchain
These are the required software tools you need to install on your computer.
Node.js
We are using Node.js v10.x. We recommend using a tool such as asdf or nvm if you need to install more than one version of Node.js.
Yarn Package Manager
We are using Yarn 1.x for package management.
Git Version Control
You will need Git to get the source code from GitHub. (Say that 3 times fast!)
Getting The Code
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
If you see a 401 not authorized error after running yarn install, then you
probably skipped the logging into the Github package registry as described above.
Software Stack
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
yarn start
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.
yarn lint
Runs the code linter.
This will automatically fix most lint errors for you.
yarn test
See README in the test/ directory.
yarn build
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.
Learn More
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