mirror of
https://github.com/janishutz/libreevent.git
synced 2025-11-25 13:24:24 +00:00
last preparations for release
This commit is contained in:
@@ -57,9 +57,9 @@ If you like this project and it helped you save money, please consider donating
|
|||||||
- [website/](/website/): contains all of the website files:
|
- [website/](/website/): contains all of the website files:
|
||||||
- [website/dist/](/website/dist/): contains all the ready to distribute 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.
|
- [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. It also minifies the files in the process to reduce package size.
|
- [package.sh](/package.sh): collects all of the files of the project and copies them into the [dist/](/dist/) folder. It also automatically compiles the webapps and removes unnecessary files as well as resetting the databases and settings to the defaults.
|
||||||
- [.eslintrc.js](/.eslintrc.js): ESlint config, the linter used for the project
|
- [.eslintrc.js](/.eslintrc.js): ESlint config, the linter used for the project. Before starting a PR, make sure the linter is happy!
|
||||||
- [.gitignore](/.gitignore): ignored files, currently is node_modules & log files.
|
- [notes.md](./notes.md): Project notes, including future plans for it.
|
||||||
|
|
||||||
You may notice some additional folders appearing after running
|
You may notice some additional folders appearing after running
|
||||||
```
|
```
|
||||||
|
|||||||
58
notes.md
58
notes.md
@@ -20,61 +20,3 @@ For deployment create the following items:
|
|||||||
- FUTURE: Guest purchase
|
- FUTURE: Guest purchase
|
||||||
- FUTURE: Colour for event banner background
|
- FUTURE: Colour for event banner background
|
||||||
- FUTURE: add webpack (or any other minifying tool) to project website to decrease file size (OPTIONAL)
|
- FUTURE: add webpack (or any other minifying tool) to project website to decrease file size (OPTIONAL)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
GPL Stuff:
|
|
||||||
|
|
||||||
How to Apply These Terms to Your New Programs
|
|
||||||
|
|
||||||
If you develop a new program, and you want it to be of the greatest
|
|
||||||
possible use to the public, the best way to achieve this is to make it
|
|
||||||
free software which everyone can redistribute and change under these terms.
|
|
||||||
|
|
||||||
To do so, attach the following notices to the program. It is safest
|
|
||||||
to attach them to the start of each source file to most effectively
|
|
||||||
state the exclusion of warranty; and each file should have at least
|
|
||||||
the "copyright" line and a pointer to where the full notice is found.
|
|
||||||
|
|
||||||
libreevent - Free and Open Source Event Management and Ticketing
|
|
||||||
Solution
|
|
||||||
Copyright (C) 2023 Janis Hutz
|
|
||||||
|
|
||||||
This program is free software: you can redistribute it and/or modify
|
|
||||||
it under the terms of the GNU General Public License as published by
|
|
||||||
the Free Software Foundation, either version 3 of the License, or
|
|
||||||
(at your option) any later version.
|
|
||||||
|
|
||||||
This program is distributed in the hope that it will be useful,
|
|
||||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
||||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
||||||
GNU General Public License for more details.
|
|
||||||
|
|
||||||
You should have received a copy of the GNU General Public License
|
|
||||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
Also add information on how to contact you by electronic and paper mail.
|
|
||||||
|
|
||||||
If the program does terminal interaction, make it output a short
|
|
||||||
notice like this when it starts in an interactive mode:
|
|
||||||
|
|
||||||
libreevent Copyright (C) 2023 Janis Hutz
|
|
||||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
|
||||||
This is free software, and you are welcome to redistribute it
|
|
||||||
under certain conditions; type `show c' for details.
|
|
||||||
|
|
||||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
|
||||||
parts of the General Public License. Of course, your program's commands
|
|
||||||
might be different; for a GUI interface, you would use an "about box".
|
|
||||||
|
|
||||||
You should also get your employer (if you work as a programmer) or school,
|
|
||||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
|
||||||
For more information on this, and how to apply and follow the GNU GPL, see
|
|
||||||
<https://www.gnu.org/licenses/>.
|
|
||||||
|
|
||||||
The GNU General Public License does not permit incorporating your program
|
|
||||||
into proprietary programs. If your program is a subroutine library, you
|
|
||||||
may consider it more useful to permit linking proprietary applications with
|
|
||||||
the library. If this is what you want to do, use the GNU Lesser General
|
|
||||||
Public License instead of this License. But first, please read
|
|
||||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
||||||
|
|||||||
@@ -18,6 +18,8 @@
|
|||||||
<div id="docPage">
|
<div id="docPage">
|
||||||
<div id="doc-container">
|
<div id="doc-container">
|
||||||
<h1>Packaging</h1>
|
<h1>Packaging</h1>
|
||||||
|
<p>libreevent has a very simple packaging script built in, it's called package.sh and can be run on any bash-compatible shell. This is another thing that should be improved: Add a batch script for the same purpose, it makes Windows user's life so much easier!</p>
|
||||||
|
<h1>Setting up the development environment</h1>
|
||||||
<p>To be able to work on libreevent, you need to have node.js and npm installed on your computer.</p>
|
<p>To be able to work on libreevent, you need to have node.js and npm installed on your computer.</p>
|
||||||
<p>Then, to set up the development environment, run</p>
|
<p>Then, to set up the development environment, run</p>
|
||||||
<pre><code>npm i
|
<pre><code>npm i
|
||||||
|
|||||||
@@ -1,4 +1,14 @@
|
|||||||
# Packaging
|
# Packaging
|
||||||
|
libreevent has a very simple packaging script built in, it's called package.sh and can be run on any bash-compatible shell. This is another thing that should be improved: Add a batch script for the same purpose, it makes Windows user's life so much easier!
|
||||||
|
|
||||||
|
You can just run the script in a terminal by typing
|
||||||
|
```
|
||||||
|
./package.sh
|
||||||
|
```
|
||||||
|
when in the main directory (Linux and MacOS only, requires installed Node.js and npm).
|
||||||
|
|
||||||
|
|
||||||
|
# Setting up the development environment
|
||||||
|
|
||||||
To be able to work on libreevent, you need to have node.js and npm installed on your computer.
|
To be able to work on libreevent, you need to have node.js and npm installed on your computer.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user