SOFTware-Viz

Developed with the software and tools below.

 ## Repository Structure ```sh ├── app │   ├── app.py │   ├── __init__.py │   ├── routes │   │   ├── api_route.py │   │   ├── dashboard_route.py │   │   ├── doc.py │   │   ├── __init__.py │   │   ├── reset_db.py │   │   ├── software_count_route.py │   │   └── software_mentions_route.py │   ├── static │   │   ├── charts.js │   │   ├── css │   │   │   └── styles.css │   │   ├── data │   │   │   ├── json_files │   │   │   ├── pdf_files │   │   │   ├── xml_files │   │   │   └── xml_meta │   │   ├── result │   │   │   ├── CSV_software │   │   │   ├── XML_meta_software │   │   │   └── XML_software │   │   └── scripts.js │   └── templates │   ├── pages │   │   ├── dashboard.html │   │   ├── doc_wsoftware.html │   │   ├── software_counts.html │   │   └── software_mentions.html │   └── partials │   └── conteneur.html ├── README.md ├── requirement.txt ├── run.py └── Utils ├── dashboard.py ├── doc_info.py ├── __init__.py ├── insert_json_db.py └── software_mentions.py ``` --- ## Getting Started **System Requirements:** * **Python**: `version 3.` ### Installation

From source

> 1. Clone the repository: > > ```console > $ git clone ../ > ``` > > 2. Change to the project directory: > ```console > $ cd ./SOFTware-viz > ``` > > 3. Create a virtualenv: > ```console > $ python -m venv env > ``` > > 4. Install docker image > ```console > $ docker pull arangodb/arangodb:3.11.6 > ``` > > 5. Launch docker container > ```console > $ docker run -p 8529:8529 -e ARANGO_NO_AUTH=1 arangodb/arangodb:3.11.6 > ``` > > 6. Create the database "SOF-viz" >``` > go to the port http://localhost:8529/ and create mannualy the database named "SOF-viz" >``` > > 7. Launch the virtualenv > ```console > $ source env/bin/activate > ``` > > 8. Install the dependencies: > ```console > $ pip install -r requirement.txt > ``` > > 9. Launch the app > ```console > $ python run.py > ``` > ### Usage

From source

> Run using the command below: > ```console > (env) $ python run.py > ``` ## Contributing Contributions are welcome! Here are several ways you can contribute: - **[Report Issues](https://local/SOFTware-Viz/issues)**: Submit bugs found or log feature requests for the `` project. - **[Submit Pull Requests](https://local/SOFTware-Viz/blob/main/CONTRIBUTING.md)**: Review open PRs, and submit your own PRs. - **[Join the Discussions](https://local/SOFTware-Viz/discussions)**: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. **Fork the Repository**: Start by forking the project repository to your local account. 2. **Clone Locally**: Clone the forked repository to your local machine using a git client. ```sh git clone ../ ``` 3. **Create a New Branch**: Always work on a new branch, giving it a descriptive name. ```sh git checkout -b new-feature-x ``` 4. **Make Your Changes**: Develop and test your changes locally. 5. **Commit Your Changes**: Commit with a clear message describing your updates. ```sh git commit -m 'Implemented new feature x.' ``` 6. **Push to local**: Push the changes to your forked repository. ```sh git push origin new-feature-x ``` 7. **Submit a Pull Request**: Create a PR against the original project repository. Clearly describe the changes and their motivations. 8. **Review**: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

--- ## License This project is protected under the [SELECT-A-LICENSE](https://choosealicense.com/licenses) License. For more details, refer to the [LICENSE](https://choosealicense.com/licenses/) file. --- ## Acknowledgments - List any resources, contributors, inspiration, etc. here. [**Return**](#-overview) ---