Basic Requirements
To successfully install EventSlip, these Basic requirements must be adhered to
- IDE for Web and Mobile development. Preferred Options - VSCode and Android Studio.
- Flutter SDK and JDK with path setup in your IDE.
- Web server or Local Machine. Preffered Option - Apache with Cpanel Installed
Warning
The Codester Item price does not include any kind of installation and app publishing support.
You need to follow this documentation step by step for installation, setup and any other branding related changes.
We are not responsible for your mistake. Also if you do any kind of customization on the script, it is totally your responsibility.
Server Requirements
The following are server required specifications for EventSlip
- PHP version 7.4+ and MySQL 5.7+
- BCMATH PHP Extension
- CTYPE PHP Extension
- JSON PHP Extension
- MBSTRING PHP Extension
- OPENSSL PHP Extension
- PDO PHP Extension
- PDO_MYSQL PHP Extension
- TOKENIZER PHP Extension
- XML PHP Extension
- CURL PHP Extension
- FILEINFO PHP Extension
In most cases, these extensions are enabled by default, but check with your hosting provider in the event that any of them is missing.
Mobile App Requirements
These are requirements to setup the Ticket Scanning App:
- Android studio
- VSCode
- Flutter SDK setup (version 2.8.1 Stable)
- JDK with path setup (Only for VScode)
- Xcode for IPA file build (Only if you want to publish for iOS)
Web App Installation
STEP - 01
Download file from codester and extract on your pc. You will see the 3 folders listed below:
- Documentation
- TicketScanner
- UploadToServer
STEP - 02
Open the "UploadToServer" folder, this folder contains a zip file as shown in the image below. You will have to upload this zip file to your server using ftp or file manager.
STEP - 03
Now login to your server. For illustration purpose, we will use cpanel all through this documentation. Go to > MySQL® Database Wizard
STEP - 04
Enter a name for your database and create database
STEP - 05
Create Database User, do not forget to copy and keep your database user password, we will need this later to run the installation wizard
STEP - 06
Add user to the database. Check all privileges and click "Make Changes". then click “Next Step”
Database creation is done, copy and keep database name, database username and database password in a safeplace. We will need them later. Click "Return Home"
STEP - 07
Upload the EventSlip zip file as shown in Step 02 to the directory you wish to install it on your server and extract the zip file there. This can be your root public directory, sub domain or sub folder
STEP - 08
Visit your site domain E.g www.yoursite.com. The first time you will visit this link, you will be automatically redirected to the Installation Wizard as shown in the image below. Ensure
all the requirements are checked with a green check icon then click on "Next". In the event you have any extension marked with red icon, please install that extension then continue.
Make sure you have given 0755 folder permission to the folders listed in the next screen as shown below. Then click "Next"
On the next screen, fill up the form with the database name, database username and password you created in Steps 03 - 06. Then click on "Check Connection"
If the provided credentials are correct, you will see a success alert as shown in the image below. Then click "Next"
Fill up the form on next screen with the system Super Admin credentials as shown below then click "Install Now". You will be using this admin email and password to login to the website admin panel so keep it safe.
Once you see success alerts as shown on the image below, congrats you have successfully installed EventSlip. Click "Go To Site" to visit your website
Admin Panel Setup
Congrats... You successfully installed EventSlip on your server. Next up is to configure and setup your website to function properly.
Visit www.yoursite.com/admin and login with admin credentials
Web Config
From the Side Menu, navigate to Web & App Settings >> Web Config
- Business Mode - Here, you can toggle between Single Vendor or Multi-Vendor
- Organizer Registration - You can also turn Organizer registration On/Off
- Google Map API Key - This is required for venue address during events listing
- Other settings like Website logo, Favicon, Company Name, Site Color etc can also be set from here.
ReCaptcha Settings
Navigate to Web & App Settings >> ReCaptcha Settings
The Google reCaptcha protects your login forms from bots. If you do not setup the google reCaptcha, the built in Laravel captcha will be used
Pages Setup
Navigate to Web & App Settings >> Pages Setup
Here you can setup homepage banner, about us page content, privacy policy etc..
Payment Methods
Navigate to Business Settings >> Payment Methods
EventSlip ships with Paypal, Stripe, PayStack, Flutterwave and PayTm.. You should setup your preffered Payment gateway here. More payment Gateways will be added in subsequent updates.
Payout Methods
Navigate to Business Settings >> Payout Methods
Payout Methods are required if you are running in multi-vendor business mode. This is for Organizers Withdrawal requests.
Mail Config
Navigate to Business Settings >> Mail Settings >> Mail Config
You can use PHP Mail, SMTP or SendGrid API. This is required for general system mails, OTPs, password recovery etc.
EventSlip ships with custom Email templates which are easily customizable just navigate to Global Template
& Email Templates to customize them as you wish.
SMS Module
Navigate to Business Settings >> SMS Module
The SMS Module is required if you opted to use Phone OTPs instead of Email OTPs in the Web Config section.
EventSlip ships with the following SMS Gateways: Africa's Talking, Nexmo(Vonage) and Releans SMS
Language & Currency
EventSlip is a multi-language and multi-currency system. You can easily manage/add new languages and
currencies by navigating to Languages & Currencies respectively
Info
Other sections of the Admin Panel are pretty straight forward and easy to use.
Flutter SDK
Follow the official documentation from flutter.dev for your preffered dev environment.
Run the command below on your Terminal
flutter doctor
Check to confirm everything is setup correctly
Setup & Customization
Open the downloaded file from codester. You will see the 3 folders listed below:
- Documentation
- TicketScanner
- UploadToServer
Then open "TicketScanner" folder to get a zip file EventSlipScanner.zip. Extract to your preffered location on your PC
and then open the project with your preffered IDE E.g VScode
Run the command below in your terminal to get all packages
flutter pub get
Change App Logo
You can generate app icons from this website https://appicon.co
- Go to /assets/images/ and replace logo.png with your own logo.
- Go to /android/app/src/main/res and replace all mipmap folder with your generated icons android folder.
- Go to /ios/Runner and replace Assets.xcassets with your generated Assets.xcassets folder.
Change App Name
- You need to setup your app name in 3 different places.
Open /lib/utils/app_constants.dart and set the value of appName
static const String appName = 'EventSlip Scanner';
- Change the value of label from /android/app/src/main/AndroidManifest.xml
android:label="EventSlip Scanner"
- Change the value of CFBundleName from /iOS/Runner/info.plist
<key>CFBundleName</key>
<string>Eventslip Scanner</string>
Change Base URL
Open /lib/utils/app_constants.dart and replace baseURL variable value with your own URL.
You must have installed the web app from previous steps then copy your domain url and enter
here as your base url. DO NOT add the trailing backslash (/). See the code sample below
static const String baseURL = 'https://yourwebsite.com';
Change App Package Name
Check to find out the existing package name. You can find it at the very top of /app/src/main/AndroidManifest.xml file.
Now right click on project folder from android studio and click replace in path. You will get a popup window with 2 input boxes.
In the first box, enter the existing package name
that you copied from the AndroidManifest.xml file then enter your preferred package name in second box. Finally click on Replace All button.
Change App Color
For Light Theme: Open /lib/theme/light_theme.dart file and set primaryColor, cardColor, etc.
For Dark Theme: Open /lib/theme/dark_theme.dart file and set primaryColor, cardColor, etc.
App Build & Release
Build for Android
For debug build, run the command below:
flutter build apk
For deploying to playstore, please follow this documentation: https://docs.flutter.dev/deployment/android
Build for iOS
Apple does not allow direct debug app build and install.
If you want to install the app on your iOS device then you have to deploy it on TestFlight or AppStore.
For deploying, please follow this documentation: https://docs.flutter.dev/deployment/ios
Web App Update
STEP - 01
Backup your website files and Database.
STEP - 02
Download file from codester and extract on your pc. You will see the 3 folders listed below:
- Documentation
- TicketScanner
- UploadToServer
STEP - 03
Open the "UploadToServer" folder, this folder contains 2 zip files. You only need the Update_xx_to_xx file. You will have to upload this zip file to your server using ftp or file manager and extract the content to overwrite your existing files.
STEP - 04
Back on your PC, extract the content of the zip file Update_xx_to_xx. Inside the folder contents, there's a database file named update_db_vx.sql. You will need this file in the next steps.
STEP - 05
Now on your server, Go to > phpMyAdmin and open your database.
STEP - 06
Click on IMPORT and select the database file update_db_vx.sql discussed above. Once imported, congratulations your website is now updated.