diff --git a/.gitignore b/.gitignore index 9b3cb07..c963870 100644 --- a/.gitignore +++ b/.gitignore @@ -11,4 +11,7 @@ *.log # ignore node_modules (can be rebuilt with npm i --> shrinks repo size) -node_modules \ No newline at end of file +node_modules + +# ignore dist folder (this repo only contains source code!) +/dist \ No newline at end of file diff --git a/README.md b/README.md index d18ea9b..3c4f821 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,10 @@ Visit our [website](https://myevent.janishutz.com) - any CPU from the last 10 years - Any operating system that can run node.js +# Download +You may download this project using the GitHub releases page or the direct links on the [myevent website](https://myevent.janishutz.com/download) as this only downloads the ready-to-distribute version, not the development version. +Alternatively, you may download the project directly from GitHub (by cloning it or downloading the code) but you'll have to compile and package the project [manually](https://myevent.janishutz.com/docs/contributing/packaging). + # 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. @@ -31,16 +35,22 @@ If you like this project and it helped you save money, please consider donating # Repository structure - [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: - - - - + - [src/apps](/src/apps/): contains the source code of the iOS and Android app. + - [src/server](/src/server/): contains the source code for the node.js application that runs on the server side. + - [src/webapp](/src/webapp/): contains the source code for the frontend, contains lots of vue files. - [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. +- [package.js](/package.js): collects all of the files of the project and copies them into the [dist/](/dist/) folder. It also minifies the files in the process to reduce package size. - [.eslintrc.js](/.eslintrc.js): ESlint config, the linter used for the project -- [.gitignore](/.gitignore): ignored files, currently is node_modules. +- [.gitignore](/.gitignore): ignored files, currently is node_modules & log files. + +You may notice some additional folders appearing after running +``` +npm run package +``` +This is to shrink the repository size. Distribution ready files can be found in the releases or on our [website](https://myevent.janishutz.com/download). ## This project is currently NOT ready to be used! Development of this project is currently ongoing and no stable version is available yet. diff --git a/package.sh b/package.js similarity index 100% rename from package.sh rename to package.js diff --git a/package.json b/package.json new file mode 100644 index 0000000..014791a --- /dev/null +++ b/package.json @@ -0,0 +1,24 @@ +{ + "name": "myevent", + "version": "1.0.0", + "description": "A free and open source event management solution", + "main": "/dist/app.js", + "scripts": { + "test": "npm run test" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/simplePCBuilding/myevent.git" + }, + "keywords": [ + "eventmanager", + "events", + "tickets" + ], + "author": "Janis Hutz", + "license": "GPL-3.0-or-later", + "bugs": { + "url": "https://github.com/simplePCBuilding/myevent/issues" + }, + "homepage": "https://myevent.janishutz.com" +}