diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 9a32973..c90c9c9 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,11 +1,7 @@ --- name: Bug report about: Create a report to help us improve -title: '' labels: bug -assignees: CyB3RC0nN0R, delvh, DieGurke, derharry333 -projects: Envoy -milestone: Envoy v0.2-beta --- **Describe the bug** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 07b3e9b..2356405 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,11 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: enhancement, feature -assignees: CyB3RC0nN0R, delvh, DieGurke -project: Envoy -milestones: Envoy v0.2-beta +labels: enhancement --- **Is your feature request related to a problem? Please describe.** diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 80aac4f..17fc4b4 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -24,9 +24,12 @@ jobs: restore-keys: ${{ runner.os }}-m2 - name: Build with Maven run: mvn -B package + - name: Stage build artifacts + run: | + mkdir staging + cp server/target/envoy-server-jar-with-dependencies.jar staging/envoy-server.jar + cp client/target/envoy-client*shaded.jar staging/envoy.jar - uses: actions/upload-artifact@v2 with: name: envoy-${{ matrix.os }} - path: | - server/target/envoy-server-jar-with-dependencies.jar - client/target/envoy-client*shaded.jar + path: staging diff --git a/README.md b/README.md new file mode 100644 index 0000000..7a7cfca --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Envoy +--- + +GitHub milestone +GitHub pull requests +GitHub issues + + +**Envoy** is a messenger written in Java.
+It is split into three separate components: Envoy Client, Envoy Common and Envoy Server. +




+--- +### Envoy Client: +This is the only part users are interested in. It contains everything to make this messenger work: the UI. +### Envoy Server: +Envoy offers the option to download and host your own server over which Envoy can run.
+This part will be especially appealing to institutions/organizations who want to self-host Envoy. +### Envoy Common: +This part contains elements that both the client and the server need. It will be automatically part of either one (Thanks, Maven!). + +## Features + +Envoy features a lot of things and many more are yet to come. +Currently existing features are: + +#### 'Client' contains: + +* typical Messenger features (sending and receiving of messages, groups, sending images and voice messages) +* typical Messenger feeling (displaying unread messages) +* Appealing user interface (UI) + +* Programming + * API to change default configuration + * Advanced logging possibilities + * Tons of Events to interact with + * Detailed Javadoc to improve readability of code + +#### 'Common' contains: +* the event system +* the logger +* Envoy-specific Exceptions +* some util classes +* the most basic datatypes + +#### 'Server' contains: +* the database implementation of the data classes +* the connectivity classes +* processors to handle incoming events +* Utility classes to check client version compatability and Password validity diff --git a/client/.settings/org.eclipse.jdt.ui.prefs b/client/.settings/org.eclipse.jdt.ui.prefs index 1d718a1..359aaeb 100644 --- a/client/.settings/org.eclipse.jdt.ui.prefs +++ b/client/.settings/org.eclipse.jdt.ui.prefs @@ -6,4 +6,4 @@ org.eclipse.jdt.ui.importorder=java;javax;javafx;org;com;envoy; org.eclipse.jdt.ui.javadoc=true org.eclipse.jdt.ui.ondemandthreshold=4 org.eclipse.jdt.ui.staticondemandthreshold=2 -org.eclipse.jdt.ui.text.custom_code_templates=