Newer
Older
## Autosubmit GUI: React App Documentation
### Introduction:
Autosubmit GUI is a software made up of two separate components. A web ppplication based on ReactJS, and a web service API written on Python. This documentation is about the former: The ReactJS App.
We begin by emphasizing the fact the application is written using Javascript with some ReactJS flavored syntax, e.g. JSX. However, the developer familiar with Javascript should not have problems understanding the main code of this application.
You can find more information about **React** in the following link: [https://reactjs.org/docs/getting-started.html](https://reactjs.org/docs/getting-started.html)
The main development framework is **npm**, we are currently using version `6.9.0`. You can find the main **npm** dependencies in the file: [package.json](package.json).
Refer to: [npm documentation](https://docs.npmjs.com/) for more information about installation and first steps on this platform.
Apart from that, there are other dependencies included mainly related to the Graphical Interface, these are:
* Bootstrap 4
* Font-awesome
* Vis-Network main css library
You can check the URL of these libraries in the file: [index.html](/public/index.html).
It might be useful to mention that this software was developed using Visual Studio Code. I guess any other IDE should do it.
### Requirements:
As mentioned before, this project includes some technology that might be unfamiliar. So, let me just mention some things that you should have some knowledge about to ease your period of adaptation:
* Javascript: asynchronous functions, promises, event handling, etc.
* Bootstrap 4 and CSS in general
* DOM manipulation
* JSON
* ReactJS
### Project Description:
Each folder includes a README file with the description of the main files and folders inside it, some of them might not include it because their content is trivially described or just plain obvious.