diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..450068f4884ccac9ccdb0f2fd1b594fbc7a3e48c --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Chaos Parcel Service: Customer frontend + +This is the customer facing part of the Chaos Parcel Service. + +This will be the main point to adjust for your Event. + +You need a working npm installation to build the frontend from src + +## Customizing +*As the software is still in heavy development, you most likely will encounter bugs we want to fix. +Use your own branch to ease the merging of bugfixes from main. +We like patches + +### building +The files are all delivered from the "dist" folder. You can always delete all files inside and run +``` +npm run build +``` +to reset your files. + +### Assets +- src/static/favicon.png + The sites favicon +- src/static/logo.png + The logo used in the qr codes +- src/static/facility.svg + The image display on the index/welcome page + +- src/static/fonts + src/scss/index.scss + Adjust these to your events font. + +### html +- src/views/index.html + Your main page. + Go wild here. The only required item is the button to generate a new delivery +- src/views/edit.html + The Sticker page. + Be carefull when editing these. + The text part are in the components subfolder. + We very much like patches here.