Skip to content

arm-diaz/Geneall

 
 

Repository files navigation

🧬 Mobile app for teaching and learning genetics

React native GitHub top language Repository size GitHub last commit Repository issues GitHub license

About the project    |    Technologies    |    Installation    |    Run in dev mode    |    License

Geneall intro demo GIF

📌 About the project

🧬 Geneall is a tool for teaching and (mainly) learning genetics and its important terms. Thus, the mobile app contains a complete list with the explanation of the most relevant concepts in genetics, as well as links for related trustable web pages, papers and videos.

The concepts are displayed through three glossaries, divided by branches of genetics:

  • 🧪 Molecular genetics,
  • 👪 Transmission genetics and
  • 🔬 Cytogenetics.

Besides that, the app also contains a series of books about genetics and heredity, written by doctors and renowned scientist in the field. They are good recommendations for those who are looking for deeper study materials.

Glossaries demo GIF        Books demo GIF

✊ Motivation

The surprising advances in genetics put its teaching in a prominent position, with important implications for social and ethical issues. In this context, there is a need for an emphasis on teaching and learning the content of genetics and heredity during high school. However, these subjects often become difficult to study and learn due to numerous important terms that must be associated by the student over a short period of time. From this perspective, Geneall aims to facilitate the process, compiling information in a much more accessible way.

📊 Project status

Geneall still currently in development. In the present moment, the very first beta version has been subjected to user tests. Posteriorly, the collected feedbacks will be used to make improvements and, finally, release the first official version of the app.

✍️ Authors

🚀 Technologies

Some main libraries used in the development are named below. However, the complete list of dependencies may be found in the package.json file.

🎉 Installation

The beta Android APK can be directly downloaded from Releases page!

💡 By default, Android blocks the installation of applications outside Google Play Store. So, to proceed, you are going to need to allow app installs from Unknown Sources in your device.

🚧 Disclaimer: As that is the first beta version, the app may contain bugs.

ℹ️ Run in dev mode

First thing first, you are going to need to have installed in your machine:

Optionally, if you wish to edit the code, I would recommend Visual Studio Code. Next, having ensured that the prerequisites are properly installed and configured, you may follow the steps described below.

# Clone this repository
# It is also possible to download the source code zip file then extract it
$ git clone https://github.com/victor-kayan/Geneall

# Change to the project directory that you have just cloned
$ cd Geneall

# Install dependencies
$ npm install
# Or...
$ yarn

# Build the app and start it on a connected Android/iOS emulator or device

# Run on Android
$ react-native run-android

# Or run on iOS
$ react-native run-ios

# If the app does not automatically start, execute it manually
$ react-native start

📝 License

This project is under MIT License. Take a look at LICENSE.md for details.


Made with 💙 by Victor Kayan

About

🧬 App for teaching and learning genetics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 87.9%
  • Java 4.3%
  • Ruby 3.6%
  • Objective-C 2.9%
  • Starlark 1.3%