Kraken – Student Analytics Made Smarter

What is Kraken?

Kraken Education is a startup founded by Advait Variyar and Dylan D’Souza in order to help teachers organise all their classroom resources in one helpful desktop app.

Kraken helps teachers out with reports on how the class is doing with useful graphs and charts. It allows teachers to enter assessment marks and see how a student has progressed, how the student is doing compared to the class, and many more such visualisations. Kraken also has a few side features such as a database for teachers to enter their students’ marks and a few tools that help out with class planning such as dividing the class into groups, sorting students in an alphabetical or roll number wise order.

Steps to get started with Developing Kraken

NOTE:

Before you start developing on Kraken Education, ensure that you have sufficient knowledge about React, Electron and popular frameworks in the React and Electron Ecosystems. We would love to have you on board! 🚂

1. Clone the kraken repository to your device using the GitHub Desktop App

Download the app from https://desktop.github.com/ and login using your GitHub account. In the app, clone the repository by using the keybind Command+Shift+O (for MacOS) or Ctrl+Shift+O (for Windows) and selecting fierypanda347/kraken from the pop-up menu.

Clone Repository Menu on the GitHub Desktop App

You can now open the repository in the text editor of your choice by using the keybind Command+Shift+A (for MacOS) or Ctrl+Shift+A (for Windows).

2. Install Node.js, NPM and Dependencies to your device

To check if you have node.js installed on your device, open your command line tool of preference and type ‘node -v’. Ensure that you have the latest LTS version of Node installed on your device to avoid any unecessary errors during development. If you do not have node.js installed, go to https://nodejs.org/en/download/ and install the latest LTS version. NPM is the Node Package Manager that will allow us to install Dependencies. NPM is installed along with node.js.

Once you have Node.js and NPM installed, open your command line of choice and locate to the project folder. Install all dependencies by running ‘npm install’ or simply just ‘npm i’. Now you have all the tools necessary to start development.

3. Read over the project

Kraken is already a project in development. Before you start contributing, make sure you read the code. Throughout development, we have tried to add helpful comments to make the code easier to read. If you have any doubts feel free to contact Advait Variyar or Dylan D’Souza.

4. When committing files, NEVER commit node_modules files

These files are the dependencies that are added to the project. They are huge files and cannot be added to the GitHub repository. Whenever committing files, always make sure you are only committing only code files that you have recently changed and nothing else.

5. NEVER COMMIT CODE TO THE MAIN BRANCH

The Main Branch of this repository is the current final version of the app. If you do make changes to the code, please commit them to a seperate branch and issue a pull request. Once you do this, either Advait Variyar or Dylan D’Souza will go over the changes suggested and add them to the Main Branch accordingly. Learn more about GitHub branches and pull requests here:

  1. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches
  2. https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests

NOTE: Please write meaningful comments during development and fill in a genuine title and description of the commit being made to the repository.

Thank You for helping us make Kraken a great application for everyone!

GitHub

View Github