janishutz/libreevent
1
0
Fork 0
mirror of https://github.com/janishutz/libreevent.git synced 2025-11-25 05:14:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add repo structure info to readme

Browse Source
This commit is contained in:
Janis Hutz
2023-04-26 15:08:14 +02:00
committed by GitHub
parent 58ae853d71
commit ac5c71559a
1 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -16,7 +16,6 @@ A fully featured, fully free and open source event management solution you can h
Visit our [website](https://myevent.janishutz.com) Visit our [website](https://myevent.janishutz.com)
# System requirements # System requirements
- node.js V16.0+ - node.js V16.0+
- npm - npm
@@ -24,24 +23,28 @@ Visit our [website](https://myevent.janishutz.com)
- any CPU from the last 10 years - any CPU from the last 10 years
- Any operating system that can run node.js - Any operating system that can run node.js
# Contributing # Contributing
If you want to contribute to this project, please read more [here](https://myevent.janishutz.com/docs/contributing). Until the end of October 2023, no contributions can be accepted into master. If you want to contribute to this project, please read more [here](https://myevent.janishutz.com/docs/contributing). Until the end of October 2023, no contributions can be accepted into master.
# Supporting the project # Supporting the project
If you like this project and it helped you save money, please consider donating to help fund the continuous development. If you are a company, please contact me [here](https://myevent.janishutz.com/docs/sponsoring) if you want to sponsor the project and become an official partner. If you like this project and it helped you save money, please consider donating to help fund the continuous development. If you are a company, please contact me [here](https://myevent.janishutz.com/docs/sponsoring) if you want to sponsor the project and become an official partner.
# Repository structure # Repository structure
- [src/](/src/) - [assets/](/assets/): contains the logo (as png and GIMP file), also iOS and Android marketing materials, just global assets (images / videos)
- [dist/](/dist/): contains all files needed to run the app, set up correctly so you can just copy the folder.
- [src/](/src/): contains all of the source code of the project:
-
-
- [website/](/website/): contains all of the website files:
- [website/dist/](/website/dist/): contains all the ready to distribute website files
- [website/src/](/website/src/): contains all of the source files (markdown format) for the website. These files are converted into HTML by the build script.
- [package.js][/package.js]: collects all of the files of the project and copies them into the [dist/](/dist/) folder.
- [.eslintrc.js](/.eslintrc.js): ESlint config, the linter used for the project
- [.gitignore](/.gitignore): ignored files, currently is node_modules.
## This project is currently NOT ready to be used! ## This project is currently NOT ready to be used!
Development of this project is currently ongoing and no stable version is available yet. Development of this project is currently ongoing and no stable version is available yet.
## ROADMAP ## ROADMAP
The goal is to get this tool fully functioning by the End of September 2023. The goal is to get this tool fully functioning by the End of September 2023.