SinusFox
60 lines
2.1 KiB
Markdown
60 lines
2.1 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](#installation)
|
|
- [Usage](#usage)
|
|
- [Supported problem Types](#supported-problem-types)
|
|
- [Contributing](#contributing)
|
|
- [Licence](#licence)
|
|
- [Contact](#contact)
|
|
- [Troubleshooting](#troubleshooting)
|
|
## Features
|
|
ToDo
|
|
## Installation
|
|
### On web
|
|
You can always use the OR-Tool [without any installation](https://spaceholder-programming.github.io/Operations-Research-Tool/).
|
|
### Local
|
|
1. 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.
|
|
2. Clone the repository:
|
|
```Bash
|
|
git clone https://github.com/Spaceholder-Programming/Operations-Research-Tool.git
|
|
```
|
|
3. Build the site:
|
|
Open the folder where the project was saved in PowerShell (or your favorite console). Then build the site:
|
|
```Bash
|
|
npm build
|
|
```
|
|
4. Run it:
|
|
```
|
|
npm start
|
|
```
|
|
5. Access the OR-Tool using your browser:
|
|
Usually it starts on port 3000. [This link](http://localhost:3000) should work. Otherwise check your console for the link.
|
|
## 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
|
|
|
|
For further information, please check out the [LICENSE](https://github.com/Spaceholder-Programming/Operations-Research-Tool/blob/main/LICENCE.md).
|
|
# 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://giothub.com/moebiusl)
|
|
+ [SinusFox](https://github.com/SinusFox)
|
|
+ [widepoeppihappy](https://github.com/widepoeppihappy)
|
|
# Troubleshooting
|
|
If you find erros in the code, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).
|