Developer Setup
Last updated
Last updated
Before you get started, there are a few dependencies that you will need to make sure you have installed before contributing toToyNet.
toynet-react
is ToyNet's frontend service and is written in React using Typescript. To get started with local development make sure that you have the correct dependencies installed as listed above.
If you are not a not a member on Project Reclass' GitHub organization, you will first need to fork the toynet-react
repository.
To fork the repository, you will need to go to the and click the "fork" button in the top right. You will use this new repository to make pull requests against the main Project Reclass repository.
Install all of the dependencies using npm i
Update the proxy
field of the package.json
to be https://toynet.projectreclass.org
Start the development server with npm run start
This will start up the development server. This server includes hot reloading so any changes made to the application will cause a re-build and will refresh your browser.
There are several npm scripts that can be used in your development that can be ran with npm run [script]
If using something like set export DANGEROUSLY_DISABLE_HOST_CHECK=true
before running npm start
More information
Note: See the for more information on building and developing toynet_mininet
.
The following tutorial applies to Linux / MacOS development environments. Visit Windows documentation .
Visit to generate living documentation about available API endpoints alongside your flask instance.
Visit to learn how to unit test, run manual tests in development, and query SQLite files.