Skip to content

dominik1001/virusim-app

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

120 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CircleCI TypeScript

ViruSim

Fighting SARS-CoV-2 with education.

We're actively looking for contributors. Please have a look at the Contributing section.

Vision

ViruSim will be a configurable simulation of a viral infection on a cellular level. The software is intended to be used inside the browser mainly for educational purposes (for example using it in online courses about viruses, immunology and viral infections). Therefore nice visuals will be a main part of this project. This project is open-source and non-profit. While the primary focus for this project will most probably be educational purposes further (scientific) applications might be possible in the future.

Getting started

Live version

A live version of the software can be found at https://www.virusim.org.

Running locally

To start development and run the project locally, run

npm install
npm start

Then open http://localhost:8000 in your web browser.

Learning about viruses

A very good starting point is the following online course:

Deployment

The master branch is automatically deployed to https://www.virusim.org after passing the continuous integration on CirlceCI at https://circleci.com/gh/dominik1001/virusim.

Tech Stack

Contributing

Who are you looking for?

Currently we're looking for enthusiastic people who are willing to join this open-source and non-profit project. Concretely we're looking for:

  • JavaScript/TypeScript developers ideally with a background in 2D/3D rendering
  • Biologists/Immunologists/Virologists/MDs to guide the project and to input useful requirements and domain-specific knowledge ideally with an educational background
  • 2D/3D Designers

How do I contribute?

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

About

Fighting SARS-CoV-2 with education.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors