diff --git a/README.md b/README.md index ed3f9b9..fa48712 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # myevent A fully featured, fully free and open source event management solution you can host yourself, to manage your event and sell tickets. All you need is a webserver that can run node.js! +Visit our [website](https://myevent.janishutz.com) + ## 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/apps/Android/README.md b/src/apps/Android/README.md similarity index 100% rename from apps/Android/README.md rename to src/apps/Android/README.md diff --git a/apps/iOS/README.md b/src/apps/iOS/README.md similarity index 100% rename from apps/iOS/README.md rename to src/apps/iOS/README.md diff --git a/server/admin/pwdmanager.js b/src/server/admin/pwdmanager.js similarity index 100% rename from server/admin/pwdmanager.js rename to src/server/admin/pwdmanager.js diff --git a/server/admin/routes.js b/src/server/admin/routes.js similarity index 100% rename from server/admin/routes.js rename to src/server/admin/routes.js diff --git a/server/app.js b/src/server/app.js similarity index 100% rename from server/app.js rename to src/server/app.js diff --git a/server/backend/db/interact.js b/src/server/backend/db/interact.js similarity index 100% rename from server/backend/db/interact.js rename to src/server/backend/db/interact.js diff --git a/server/backend/routes.js b/src/server/backend/routes.js similarity index 100% rename from server/backend/routes.js rename to src/server/backend/routes.js diff --git a/server/package-lock.json b/src/server/package-lock.json similarity index 100% rename from server/package-lock.json rename to src/server/package-lock.json diff --git a/server/package.json b/src/server/package.json similarity index 100% rename from server/package.json rename to src/server/package.json diff --git a/server/ui/css/style.css b/src/server/ui/css/style.css similarity index 100% rename from server/ui/css/style.css rename to src/server/ui/css/style.css diff --git a/server/ui/html/index.html b/src/server/ui/html/index.html similarity index 100% rename from server/ui/html/index.html rename to src/server/ui/html/index.html diff --git a/server/ui/js/index.js b/src/server/ui/js/index.js similarity index 100% rename from server/ui/js/index.js rename to src/server/ui/js/index.js diff --git a/website/README.md b/website/README.md new file mode 100644 index 0000000..2390a29 --- /dev/null +++ b/website/README.md @@ -0,0 +1,12 @@ +# Website +The main website's pages are written in HTML & CSS whilst the doc pages are automatically generated by the script in [./build](build/). +** DO NOT MODIFY THE DOC PAGES IN THE [dist/docs/](dist/docs/) DIRECTORY! ** + +## Links in the md files in [src/](src/) +Please note that you are required to use either a link relative to the root folder with double forward slash (example: *//server/app.js*), to the website root with a single forward slash (example: */download*) or a full link (example: *https://myevent.janishutz.com/docs*). If you do not follow these patterns, the website won't build or the links will not work correctly. NOTE: Don't be confused if the root folder links don't work in the Markdown, as they use specific syntax for the build script. + +## Folder structure and file naming +Please create an *index.md* file inside of a folder such that, when the website is compiled, the *.html* file extension disappears. + +## Modifying the files in [dist/](dist/) +You may modify all the files in the [dist/](dist/) directory except the files in [dist/docs/](dist/docs/). \ No newline at end of file diff --git a/website/docs/index.html b/website/dist/about/index.html similarity index 100% rename from website/docs/index.html rename to website/dist/about/index.html diff --git a/website/assets/logo.png b/website/dist/assets/logo.png similarity index 100% rename from website/assets/logo.png rename to website/dist/assets/logo.png diff --git a/website/css/home.css b/website/dist/css/home.css similarity index 100% rename from website/css/home.css rename to website/dist/css/home.css diff --git a/website/css/style.css b/website/dist/css/style.css similarity index 100% rename from website/css/style.css rename to website/dist/css/style.css diff --git a/website/docs/js/index.js b/website/dist/docs/index.html similarity index 100% rename from website/docs/js/index.js rename to website/dist/docs/index.html diff --git a/website/js/index.js b/website/dist/docs/js/index.js similarity index 100% rename from website/js/index.js rename to website/dist/docs/js/index.js diff --git a/website/dist/download/index.html b/website/dist/download/index.html new file mode 100644 index 0000000..e69de29 diff --git a/website/dist/footer.html b/website/dist/footer.html new file mode 100644 index 0000000..e69de29 diff --git a/website/index.html b/website/dist/index.html similarity index 100% rename from website/index.html rename to website/dist/index.html diff --git a/website/dist/js/index.js b/website/dist/js/index.js new file mode 100644 index 0000000..7745b20 --- /dev/null +++ b/website/dist/js/index.js @@ -0,0 +1,9 @@ +/* +* myevent - index.js +* +* Created by Janis Hutz 03/06/2023, Licensed under the GPL V3 License +* https://janishutz.com, development@janishutz.com +* +* +*/ + diff --git a/website/dist/nav.html b/website/dist/nav.html new file mode 100644 index 0000000..0a98019 --- /dev/null +++ b/website/dist/nav.html @@ -0,0 +1,12 @@ + + + + + + + nav + + + + + \ No newline at end of file