Updated Readme file and fixed minor bugs #58
@@ -847,6 +847,10 @@ FodyWeavers.xsd
|
||||
|
||||
### VisualStudio Patch ###
|
||||
# Additional files built by Visual Studio
|
||||
/.idea/.gitignore
|
||||
/.idea/modules.xml
|
||||
/.idea/Operations-Research-Tool.iml
|
||||
/.idea/vcs.xml
|
||||
|
||||
### Added by npx/npm for Next.JS ###
|
||||
# dependencies
|
||||
|
||||
@@ -3,57 +3,75 @@ This projects aims to create a tool for easy calculation of operations research
|
||||
|
||||
## Table of Contents
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Installation/Access](#installationaccess)
|
||||
- [Usage](#usage)
|
||||
- [Supported problem Types](#supported-problem-types)
|
||||
- [Supported problem types](#supported-problem-types)
|
||||
- [Contributing](#contributing)
|
||||
- [Licence](#licence)
|
||||
- [License](#license)
|
||||
- [Contact](#contact)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Issues](#issues)
|
||||
|
||||
## Features
|
||||
ToDo
|
||||
## Installation
|
||||
### On web
|
||||
You can always use the OR-Tool [without any installation](https://spaceholder-programming.github.io/Operations-Research-Tool/).
|
||||
- Export as LP (Linear Programming) and MPS(Mathematical Programming System)
|
||||
- Measuring elapsed real time
|
||||
- Logging
|
||||
- Solving via GLPK
|
||||
|
||||
## 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
|
||||
1. Install dependencies:
|
||||
#### 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:
|
||||
#### Clone the repository
|
||||
Using Git:
|
||||
```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:
|
||||
#### Building the site
|
||||
Navigate towards the folder, where the project is located on your machine via terminal.
|
||||
Afterwards, execute the following command:
|
||||
|
||||
```Bash
|
||||
npm install
|
||||
```
|
||||
This installs the necessary dependencies.
|
||||
Next execute:
|
||||
```Bash
|
||||
npm build
|
||||
```
|
||||
4. Run it:
|
||||
#### Run
|
||||
```
|
||||
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
|
||||
#### Access the Tool using your browser:
|
||||
You can access the tool via browser on your machine. The default port is 3000.
|
||||
|
||||
ToDo
|
||||
### Supported problem Types
|
||||
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
|
||||
The tool provides a user-friendly interface to solve operations research problems. You can access it locally after installation or through the web interface if hosted online.
|
||||
Solving a Problem
|
||||
Input your model data in the boxes (constraints, variables, objective functions).
|
||||
Click "Calculate" to see the results.
|
||||
|
||||
### Supported problem types
|
||||
+ Linear
|
||||
+ Mixed Integer
|
||||
|
||||
## Contributing
|
||||
1. Fork the repository
|
||||
2. Create a new branch: `git checkout -b Featurename`
|
||||
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).
|
||||
# License
|
||||
This project is licensed under the [MPL-2.0 License](https://github.com/Spaceholder-Programming/Operations-Research-Tool?tab=MPL-2.0-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://giothub.com/moebiusl)
|
||||
+ [moebiusl](https://github.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).
|
||||
# Issues
|
||||
If you encounter a bug, please contact us by [creating an issue](https://github.com/Spaceholder-Programming/Operations-Research-Tool/issues/new).
|
||||
|
||||
Vendored
+6
@@ -0,0 +1,6 @@
|
||||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
/// <reference types="next/navigation-types/compat/navigation" />
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/app/building-your-application/configuring/typescript for more information.
|
||||
Reference in New Issue
Block a user