With inspiration, I want to learn how to develop a circuit simulator. Through documenting the process, I hope that it could serve as a useful and clear guideline on how to develop a circuit sim, too. This should not be confused with my past personal project - 'Sirkit Circuit Simulator'.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You'll need the following installed on your machine to run this project.
- Node.js [https://nodejs.org/en/]
- Node Package Manager (from Node.js' installer)
Test that you can access Node and npm from your command prompt:
node --version
npm --version
Should there be an error saying either or both of them not recognised as a command, do check your Environment Variable's PATH to ensure that the locations of Node.js and NPM are present there. Refer to this for Node, and this for NPM.
- Pull / Download the project into your machine
- Open command prompt on the project's directory
- Download and install the dependencies of this project by running
npm installin the command prompt - Done! Hopefully nothing has crashed and burn at this point.
- Run
npm run live-testin the command prompt and it should start up a chrome browser that is used to run the tests (might take a minute or two) - Tests are automatically run on code changes
- Click on the 'DEBUG' button on the top right to view the test report (needs page refresh to see changes)
To end the test, press CTRL-C in your command prompt to end the session.
- Seck Wei Lim - Github
- Thom Wright - open source Javascript circuit simulator [link]