-
Notifications
You must be signed in to change notification settings - Fork 80
/
README.txt
129 lines (102 loc) · 6.41 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
Brew Competition Online Entry & Management (BCOE&M)
Developed by Geoff Humphrey with code contributions by the GitHub community.
Website: http://www.brewingcompetitions.com
GitHub: https://github.com/geoffhumphrey/brewcompetitiononlineentry
Release 2.1.19, 2020-07-28
Developed utilizing a number of extensions and functions, with gratitude to their
respective developers and online communities. Tested with the following versions:
- PHP 7.3.X http://www.php.net
-- PHP's Fileinfo extension must be installed and enabled
-- see http://php.net/manual/en/fileinfo.setup.php
- MySQL 5.5.42 http://www.mysql.com
- jQuery 3.1.0 http://jquery.com
- Bootstrap 3.3.7 http://getbootstrap.com
- DataTables 1.10.12 http://www.datatables.net
- Fancybox 2.1.5 http://www.fancyapps.com
- TinyMCE 4.4.0 http://www.tinymce.com
- Jasny Bootstrap 3.1.3 http://www.jasny.net/bootstrap
- DropZone 4.2.0 http://www.dropzonejs.com
- Bootstrap Form Validator 0.9.0 http://1000hz.github.io/bootstrap-validator
- Bootstrap-Select 1.12.0 http://silviomoreto.github.io/bootstrap-select
- Font Awesome 4.5.0 http://fortawesome.github.io/Font-Awesome
- FPDF 1.6 http://www.fpdf.org
- PHPass 0.3 http://www.openwall.com/phpass
- Tiny But Strong 3.10.1 http://www.tinybutstrong.com
- HTML Purifier 4.9.3 http://htmlpurifier.org/
- PHPMailer 6.0.7 https://github.com/PHPMailer/PHPMailer
- Bootstrap Markdown Editor 2.0.1 https://github.com/inacho/bootstrap-markdown-editor
***********************************************************************************
LICENSE
***********************************************************************************
This software is free, open source, and is covered under the General Public
License (GPL) from the Open Source Initiative. Therefore, you are permitted to
download the full source code of the software for your own use and customize it
for your own purposes - see http://www.brewingcompetitions.com/license for more.
Brew Competition Online Entry & Management (BCOE&M) 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.
It is suggested that you fork the GitHub repository to make integration of your
code with version releases easier. We are always looking for contributers!
Direct inquiries to http://www.brewingcompetitions.com/contact
***********************************************************************************
PLEASE READ!
***********************************************************************************
Please read this entire document before attempting to install or use the
application.
Step-by-step installation instructions are available at
http://brewingcompetitions.com/install-instructions.
This software utilizes PHP 5.6.X and MySQL 5.5.X to process and store data.
Your web server needs both of these installed, configured, and ready for use.
Contact your web host if you have any questions.
To install on a local machine, we HIGHLY suggest you download and install XAMPP, a
free Apache web server package that includes both PHP and MySQL.
- Home Page: http://www.apachefriends.org/en/xampp.html
- Mac: http://www.apachefriends.org/en/xampp-macosx.html
- Windows: http://www.apachefriends.org/en/xampp-windows.html
- Linux: http://www.apachefriends.org/en/xampp-linux.html
A modern web browser is also required to take full advantage of the many HTML 5
attributes and functions of the application. The latest versions of Chrome, Firefox,
Microsoft Edge, and Safari render BCOE&M correctly. Internet Explorer is not supported.
***********************************************************************************
Help
***********************************************************************************
Installation Instructions:
http://brewingcompetitions.com/install-instructions
Upgrade Instructinos:
http://brewingcompetitions.com/upgrade-instructions
Competition Organization with BCOE&M:
http://brewingcompetitions.com/comp-org
Load Libraries Locally (No CDNs):
http://brewingcompetitions.com/local-load
Starting with version 2.0.0, online documentation/help is available within the
application. Select the question mark icon on the top navigation bar when available.
In-app help will be augmented and expanded in future releases.
Other info can be found on the GitHub repository page.
Pre-2.0.0 help is available at http://help.brewingcompetitions.com.
***********************************************************************************
About BCOE&M
***********************************************************************************
Brew Competition Online Entry & Management is an online application to assist
homebrew competition hosts (of the beer, cider, mead variety) to collect, store,
and manage their competition entry and scoring data.
The biggest challenges of organizing a homebrewing competition is knowing who has
entered what and how many, organizing judging efficiently, and reporting the
results of the competition in a timely manner. BCOE&M provides a single online
interface to collect entry and participant data, organize judging tables and
assignments, input scoring data, and report the results.
BCOE&M is free and open-source.
***********************************************************************************
Changes in This Version
***********************************************************************************
Details on the official GitHub repository:
https://github.com/geoffhumphrey/brewcompetitiononlineentry
Also check the change log at:
http://www.brewingcompetitions.com/change-log
***********************************************************************************
Fallback DB Install
***********************************************************************************
For those experiencing any issues related to the initial browser-based setup,
the bcoem_baseline_2.1.X.sql document is available in the package. It contains the
necessary database structure and dummy data for a new installation that can be
installed manually via phpMyAdmin or shell access. Be sure to follow the directions
in the document BEFORE use.