Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Electronprod committed Nov 9, 2024
1 parent bba156a commit fe9b2ec
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
HELP.md
database.db
target/
!.mvn/wrapper/maven-wrapper.jar
!**/src/main/**/target/
Expand Down
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# About EventCalendar
## What is it?
This app is designed to collect data from users to create a custom calendar. It stores administrator-approved data in a SQL database for future use.
## User interface
<img width="501" alt="image" src="https://github.com/user-attachments/assets/cb9c4ac2-6776-4c3d-a2d7-9a6a5b41548f">
<img width="502" alt="image" src="https://github.com/user-attachments/assets/b90d5359-4394-445b-9bf0-dc8376aad49f">

## Installation
1. Make sure you have JAVA 19 or higher
2. Download [latest release](https://github.com/Electronprod/EventCalendar/releases/latest) from releases page
3. Launch application using your command shell\
``java -jar EventCalendar-(your_version).jar``

### Admin panel access
1. Open your app in browser.
2. Go to your_app_domain.com/admin
3. Authorize using default credentials:
```
Login: "electron"
Password: "e"
```
5. Success! Don't forget to add account with your credentials and to delete default account.

## Licenses
The program is distributed under the MIT license. Library licenses can be viewed [here](https://github.com/Electronprod/EventCalendar/blob/master/src/main/resources/templates/license.html)
Binary file modified database.db
Binary file not shown.

0 comments on commit fe9b2ec

Please sign in to comment.