Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dabico committed Jun 10, 2024
1 parent 80a9497 commit 5e826e1
Showing 1 changed file with 22 additions and 28 deletions.
50 changes: 22 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,20 @@
<p align="center">
<a href="https://seart-dl4se.si.usi.ch/" target="_blank" rel="noopener noreferrer">
<img src="dl4se-website/src/assets/img/logo.png" alt="DL4SE Logo">
</a>
</p>
<p align="center">
<a href="https://github.com/seart-group/DL4SE/actions/workflows/maven-build.yml"><img src="https://github.com/seart-group/DL4SE/actions/workflows/maven-build.yml/badge.svg" alt="Maven Build Status"></a>
<a href="https://github.com/seart-group/DL4SE/actions/workflows/vue-build.yml"><img src="https://github.com/seart-group/DL4SE/actions/workflows/vue-build.yml/badge.svg" alt="Vue Build Status"></a>
</p>
# SEART Data Hub

# DL4SE

The DL4SE tool allows to easily create large-scale datasets that can be used to either run MSR studies or to train DL
models to automate SE tasks.
The SEART Data Hub platform allows to easily create large-scale datasets that can be used to either run empirical MSR
studies or to train Deep Learning models to automate software engineering tasks.

## Contents

This project contains several modules:

- `dl4se-model`:
A module containing domain model classes used for mapping the relational database structure to the programming
- environment;
- `dl4se-crawler`:
A standalone crawler application that we use to mine Java source code from GitHub repositories indexed by
[GitHub Search](https://seart-ghs.si.usi.ch/);
- `dl4se-src2abs`:
A modification of Michele Tufano's [src2abs](https://github.com/micheletufano/src2abs), changed for more convenient
integration into the overall platform;
- `dl4se-server`:
A Spring Boot server application that acts as our platform back-end;
- `dl4se-website`:
A front-end web-application written in Vue.
- `dl4se-model`: A module containing domain model classes used for mapping the relational database structure to the
programming environment;
- `dl4se-analyzer`: A module containing implementations of code analysis operations running on `tree-sitter`;
- `dl4se-crawler`: A standalone crawler application that we use to mine source code from GitHub repositories indexed by
[GitHub Search](https://seart-ghs.si.usi.ch/);
- `dl4se-server`: A Spring Boot server application that acts as our platform back-end;
- `dl4se-spring`: Common Spring Boot configuration and utilities used in both the server and the crawler;
- `dl4se-website`: A front-end web-application written in Vue.

## Installation and Usage

Expand All @@ -49,6 +34,15 @@ This section will detail the necessary actions for setting up and running the pr

## FAQ

### How can I report a bug, request a feature, or ask a question?
### How can I request a feature or ask a question?

If you have ideas for a feature you would like to see implemented or if you have any questions, we encourage you to
create a new [discussion](https://github.com/seart-group/DL4SE/discussions/). By initiating a discussion, you can engage
with the community and our team, and we'll respond promptly to address your queries or consider your feature requests.

### How can I report a bug?

Please add a [new issue](https://github.com/seart-group/DL4SE/issues) and we will get back to you very soon.
To report any issues or bugs you encounter, please create a [new issue](https://github.com/seart-group/DL4SE/issues/).
Providing detailed information about the problem you're facing will help us understand and address it more effectively.
Rest assured, we are committed to promptly reviewing and responding to the issues you raise, working collaboratively
to resolve any bugs and improve the overall user experience.

0 comments on commit 5e826e1

Please sign in to comment.