SinusFox
9ad9ec1a46
* Initial Push
Inititial project state
* Static demo version
* static demo site - added variables
a
* first_implementation
* Updated UI, Improved Style to be more "Reactly", added Functionality
* add parsing functions
* change folder
* Import/Export Prototype
* Adding "reactjs-popup" to package,json
* Adding GLPK source
* Rough implementation of solver + example
* Show solution in output
* example 2 + popup lib
* removing import button
This feature won't be needed in this state of the project and might come back later. Right now it serves no functional purpose.
* Removing "Popout" button
This feature won't be needed in this state of the project and might come back later. Right now it serves no functional purpose.
* Updating Logs
Now the site displays all logs created with customLog(STRING). Logs can be cleared with customLogClear();
* Adding walltime
Can be called using:
Start:
function walltimeStart() {
returns Date.now();
Stop:
function walltimeStopAndPrint(startpoint: number) {
Add startpoint as argument.
It prints the elapsed time using customLog()
* Adding duals ouput
* Adding glpk.js package
required dependency
* adding LP format export and fixing a few errors
* fixing further errors
* adding automatic build
* Moving files to correct folders
* Update nextjs.yml
* Updating README and .gitignore
README:
- added installation instructions
- added troubleshooting
gitignore:
- skipping Writerside and .idea folders
* Update LICENCE.txt
We are required to use the same license. See https://github.com/hgourvest/node-glpk/blob/master/LICENSE
* Updating icon
* Adding RegEx input checks and updating text box explanations
* Update README.md
Updating license info
Signed-off-by: SinusFox <61253950+SinusFox@users.noreply.github.com>
* Deleting license to recreate proper license
* Update layout.tsx
fixing typo
Signed-off-by: SinusFox <61253950+SinusFox@users.noreply.github.com>
* Fixing word issue
English has some false friends... like the German "Enter" is actually return in English.
* Updatint License
* Fixing design issue and updating license link
* Fixing typo in log
* Fixing white mode
* adding translations 1/2
UI Translations
Coming in 2/2: Output translations
* adding output translations
* adding minimize button
* adding unit test for rendering home page
* fixing maxmin on lp export
* Update .gitignore
* Update .gitignore
* Update scripts.ts
* Update scripts.ts
* Update README.md
* adding tests
---------
Signed-off-by: SinusFox <61253950+SinusFox@users.noreply.github.com>
Co-authored-by: moebiusl <lucas.moebius@icloud.com>
Co-authored-by: Marcel Pöppe <marcel.poeppe@gmail.com>
68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
# University-Operations-Research-Tool
|
|
This projects aims to create a tool for easy calculation of operations research modules on different device platforms.
|
|
|
|
## Table of Contents
|
|
- [Features](#features)
|
|
- [Installation/Access](#installationaccess)
|
|
- [Usage](#usage)
|
|
- [Supported problem types](#supported-problem-types)
|
|
- [Contributing](#contributing)
|
|
- [Licence](#licence)
|
|
- [Contact](#contact)
|
|
- [Troubleshooting](#troubleshooting)
|
|
|
|
## Features
|
|
- Export as LP (Linear Programming)
|
|
- Measuring elapsed real time
|
|
- Logging
|
|
- Solving via GLPK and HiGHS
|
|
|
|
## Installation/Access
|
|
### Online
|
|
You can always access the Tool without any installation on our [GitHub Pages instance](https://spaceholder-programming.github.io/Operations-Research-Tool/).
|
|
### Local
|
|
#### Install dependencies
|
|
This project relies on [NextJs](https://nextjs.org/). Please follow its [installation instructions](https://nextjs.org/docs/getting-started/installation) to get everything ready.
|
|
#### Clone the repository
|
|
Using Git:
|
|
```Bash
|
|
git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git
|
|
```
|
|
#### Building the site
|
|
Navigate towards the folder, where the project is located on your machine via terminal.
|
|
Afterwards, execute the following command:
|
|
|
|
```Bash
|
|
npm build
|
|
```
|
|
#### Run
|
|
```
|
|
npm start
|
|
```
|
|
#### Access the Tool using your browser:
|
|
You can access the tool via browser on your machine. The default port is 3000.
|
|
|
|
If you can not reach the tool under [this link](http://localhost:3000), the default port is blocked and you have to check the terminal to get the correct port.
|
|
|
|
## Usage
|
|
ToDo
|
|
### Supported problem types
|
|
+ Linear
|
|
+ Mixed Integer
|
|
|
|
## Contributing
|
|
1. Fork the repository
|
|
2. Create a new branch: `git checkout -b featurename`
|
|
3. Implement your changes
|
|
4. Push your branch: `git push origin featurename`
|
|
5. Create a pull request
|
|
# Licence
|
|
This project is licensed under the [MIT License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MIT-1-ov-file).
|
|
# Contact
|
|
If you have the desire to contact the team behind this project, use the contact details on our GitHub accounts:
|
|
+ [bRNS98](https://github.com/bRNS98)
|
|
+ [moebiusl](https://github.com/moebiusl)
|
|
+ [SinusFox](https://github.com/SinusFox)
|
|
+ [widepoeppihappy](https://github.com/widepoeppihappy)
|
|
# Troubleshooting
|
|
If you find bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new). |