What is in the download
Six folders, and which one you work in for each job.
Unzip the download anywhere without spaces or accents in the path — D:\eLernova or ~/eLernova is ideal. You will get six folders:
eLernova/
├── user_app/ Student app — Android, iOS, Web
├── instructor/ Instructor app — Android, iOS, Web
├── admin_panel/ Admin panel — Web only
├── functions/ Cloud Functions — payments, email, push
├── firebase_setup/ The one-click setup tool (rules, data, functions)
└── documentation/ This guide
The three apps
All three are Flutter projects and share the same layout, so once you can find your way around one you can find your way around all of them:
user_app/
├── lib/
│ ├── main.dart entry point: Firebase init + global services
│ ├── app.dart root widget: theme, routing, localization
│ ├── firebase_options.dart your Firebase config (written by FlutterFire)
│ ├── core/ constants, routes, services, theme, utils
│ ├── models/ one class per Firestore document
│ ├── repository/ every Firestore and Storage read and write
│ ├── modules/ one folder per screen: controllers/ views/ bindings/
│ ├── widgets/ shared UI components
│ └── localization/ one Dart file per language (en, hi, ar, de, es, fr)
├── assets/ bundled images and fonts
├── android/ ios/ web/ platform projects
└── test/ widget and unit tests
| Folder | Runs on | What it is for |
|---|---|---|
| user_app — Student app | Android · iOS · Web | Browsing, buying and learning: catalogue, cart, player, quizzes, assignments, certificates |
| instructor — Instructor app | Android · iOS · Web | Course building, live classes, marking, reviews, earnings and payout requests |
| admin_panel — Admin panel | Web only | Approvals, finance, content, branding and every platform setting |
The backend
functions/functions/index.js is the server side. It is one file, and it owns everything that must not be decided by a phone:
- Pricing and orders —
createPurchaseOrderworks out the real price, the coupon, your commission and the tax. - Payment verification —
verifyAndCompletePurchaseasks the gateway whether the money arrived, then enrolls the student and credits the instructor in a single transaction. - Email — welcome, payout requested and payout completed messages, from your own templates.
- Push — delivery and scheduled sends.
Run the setup tool is the one page you need for this folder.
The setup tool
firebase_setup/ is a small local web app that does the whole backend deploy for you: Firestore rules, indexes, Storage rules, the starter data and the Cloud Functions. You upload your service account key on its page and press Deploy.
| File | What it is |
|---|---|
start.bat / start.sh | Double-click to launch the tool |
server.js | The local server — listens on 127.0.0.1 only |
index.html | The page you use |
firestore.rules | Security rules for every collection — the single deployable source |
firestore.indexes.json | Composite indexes the queries need |
storage.rules | Who may upload and download files |
database.json | The starter data: settings, categories, templates |
export-database.js | Backs your live database up to database.json |
key.json | Your service account key. Never commit it — it is already git-ignored |
There is exactly one rules file
One Firebase project serves all three apps, and deploying rules replaces the whole ruleset. So there is a single firestore.rules, in firebase_setup/. Never create a second copy inside an app folder: whichever was deployed last would silently wipe the other apps' access.
Which folder for which job
| I want to… | Go to |
|---|---|
| Deploy rules, data and the backend | firebase_setup/ — Run the setup tool |
| Change colours, logos, titles or fonts | The admin panel, not the code — Branding |
| Change an app's name or home-screen icon | Its own folder — App name & icon |
| Add a language | The admin panel plus one Dart file — Languages & RTL |
| Build the websites | Each app folder — Prepare & build |
| Back up the database | firebase_setup/ — npm run export |
Most of the setup is not in the code at all
Branding, colours, fonts, currency, commission, taxes, gateways, policies, emails, languages and the home-page layout are all Firestore settings edited from the admin panel. The apps read them live, so a change shows up without a rebuild.