bRNS98
71 lines
2.4 KiB
Markdown
71 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).
|
|
|
|
|