If you're looking to make changes to WISE, whether it's for the server (WISE-API) or the client (WISE-Client), you've come to the right place!
WISE development uses Docker. Docker simplifies and standardizes the development environment so that developers can quickly and easily start developing WISE.
- Your machine will need at least 10GB of RAM to set up WISE development using Docker.
- If you are using Windows, It may be easier to use WSL2. Update .wslconfig to allocate at least 10GB of RAM to WSL. (reference)
- Install Docker from here. In the Docker preferences, set the RAM to at least 6GB.
- In the same folder, checkout WISE-Docker-Dev (this project), WISE-API, and WISE-Client.
$ git clone https://github.com/WISE-Community/WISE-Docker-Dev
$ git clone https://github.com/WISE-Community/WISE-API
$ git clone https://github.com/WISE-Community/WISE-Client
$ ls
WISE-Docker-Dev
WISE-API
WISE-Client
- Run
npm installin the WISE-Client directory
$ cd WISE-Client
WISE-Client $ npm install
- Run
docker compose upin the WISE-Docker-Dev directory
WISE-Client $ cd ../WISE-Docker-Dev
WISE-Docker-Dev $ docker compose up
- Wait for everything to download, compile, and start. This can take a while depending on your computer and connection speeds. When you see this in the output, all of the application has started:
...
wise-client | ** Angular Live Development Server is listening on 0.0.0.0:4200, open your browser on http://localhost:4200/ **
wise-client |
wise-client |
wise-client | ✔ Compiled successfully.
- When you see the above output in your log output, WISE will be running at http://localhost:80. Go there with your browser to load the WISE homepage.
- Log in with admin/pass, or previewuser/wise.
That's it! Any changes that you make to the source code (on both WISE-API and WISE-Client) will be automatically compiled and deployed. Changes to WISE-Client will trigger an automatic reload in the browser.
Please head over to our wiki page for additional documentation, like how to run the unit tests and commonly-used Docker commands.
Open-source license: GNU General Public License, v3. See LICENSE.txt for details.
To see WISE in action and for inquiry science curricula developed by the WISE research team at UC Berkeley, visit https://wise.berkeley.edu.
Developer discussions: https://github.com/WISE-Community/WISE-Docker-Dev/discussions
General WISE discussions: https://wise-discuss.berkeley.edu/