The software iCanSort is a learning tool to help students study and visualise sorting algorithms and their correctness available on Windows and macOS. This project i-can-sort is built with React and Electron based on NodeJS with npm.
For contributing, please refer to COUNTRIBUTING.md.
For maintenance, please refer to MaintenanceGuide.md.
For code report, please refer to CodeReport.md.
For downloading the executable software, please refer to Release.
We provide you the installation packages of the software. You can download directly here.
We also provide you a User Manual here.
You’ll need to have [email protected] with [email protected] but NO later version on your local development machine.
You can follow the link below to download for Windows and Mac.
For Windows 64-bit, you can download and install:
https://nodejs.org/dist/v14.15.3/node-v14.15.3-x64.msi
For Mac, you can download and install:
https://nodejs.org/dist/v14.15.3/node-v14.15.3.pkg
Or you can find downloads that fits your system here by yourself:
https://nodejs.org/dist/v14.15.3/
Now you shall be able to execute node -v in your terminal and see v14.15.3
In the project directory, you should run following command in your terminal in order to configure the dependencies.
npm install -g [email protected]
To install the specific npm version 6.14.9
Make sure that you see 6.14.9 in your terminal.
To ensure that you install the specific npm version 6.14.9.
Installs all the develepment dependencies.
If this step took more than 10 minutes, you shall consider to connect to eduroam or open a VPN and set proxy for npm.
npm config set proxy http://server:port
npm config set https-proxy http://server:port
Note that using a mirror may result in some error for some reason. Please use official registry.
Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
Now you shall see iCanSort in your bowswer.
Note that using broswer view the app does not utilise electron features, 'view Group's website' and 'export note' functions cannot work.
Launches the test runner in the interactive watch mode. See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes. Your app is ready to be deployed!
See the section about deployment for more information.
Builds the app and launch electron to hava a development view of this app.
Builds the app and create an installer for Windows to the dist folder.
Builds the app and create an installer for Mac to the dist folder.
Launch a web view of the Style Guidist. This will build JavaScript Doc in each folder and display them in a webpage.
We create this app by Create React App. You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
To learn Electron, check out the Electron documentation.