Developed with the software and tools below.
├── 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
System Requirements:
- Python:
version 3.
- Clone the repository:
$ git clone ../
- Change to the project directory:
$ cd ./SOFTware-viz
- Create a virtualenv:
$ python -m venv env
- Install docker image
$ docker pull arangodb/arangodb:3.11.6
- Launch docker container
$ docker run -p 8529:8529 -e ARANGO_NO_AUTH=1 arangodb/arangodb:3.11.6
- Create the database "SOF-viz"
go to the port http://localhost:8529/ and create mannualy the database named "SOF-viz"
- Launch the virtualenv
$ source env/bin/activate
- Install the dependencies:
$ pip install -r requirement.txt
- Launch the app
$ python run.py
Run using the command below:
(env) $ python run.py
Contributions are welcome! Here are several ways you can contribute:
- Report Issues: Submit bugs found or log feature requests for the `` project.
- Submit Pull Requests: Review open PRs, and submit your own PRs.
- Join the Discussions: Share your insights, provide feedback, or ask questions.
Contributing Guidelines
- Fork the Repository: Start by forking the project repository to your local account.
- Clone Locally: Clone the forked repository to your local machine using a git client.
git clone ../
- Create a New Branch: Always work on a new branch, giving it a descriptive name.
git checkout -b new-feature-x
- Make Your Changes: Develop and test your changes locally.
- Commit Your Changes: Commit with a clear message describing your updates.
git commit -m 'Implemented new feature x.' - Push to local: Push the changes to your forked repository.
git push origin new-feature-x
- Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
- Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!
Contributor Graph
This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.
- List any resources, contributors, inspiration, etc. here.