Kindie Web - Multi branch kindergarten management software

Installation Requirements

Web Service: NodeJS
Download: NodeJS
Ensure Node.js is installed to run backend services.

Database: MongoDB
Download: MongoDB
Set up MongoDB for database management.

Mail Server: https://login.mailgun.com/login/
Create an account and log in: Mailgun
Configure email sending services.

Firebase Service
Set up Firebase Console: https://console.firebase.google.com/u/0/
Configure Firebase for authentication, cloud storage, and other services

Operating System
Supported OS:
Windows: Windows 10, Windows 11, Windows Server 2018 or later
Linux: Ubuntu 22.x or higher

A. Installing services on Windows:

A-1. Install Web sevices Node.js
Visit the official website of Node.js at https://nodejs.org.
Download Node.js settings for Windows.


Open the .msi file downloaded to start the installation process. Click "Next" to install.

Follow the instructions in the installation process. Make sure you select the "Add to Path" option to facilitate the use of Node.js in Command Prompt.


Check the Node.js version was installed with Command Prompt or PowerShell:
$ node --version
$ npm --version


Next step is to install "forever" using the following command:
$ npm install forever -g

Check "forever" version:
$ forever --version

Now, once "forever" is installed, we are ready to run application.


A-2. Install database MongoDB: (Reference more on their offical web: https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-windows)
Download the MongoDB Community .msi installer from the following link: MongoDB Download Center
Select the MongoDB version that is suitable for your Windows operating system and click the "Download" button to download the installer.


Open the .msi file downloaded to start the installation process.
Select "Complete" when asked to install.


Make sure you choose the "Install MongoDB as a Service" option to automatically run as a Windows service.

You can also choose "Install MongoDB Compass" if you want to install MongoDB Compass, a GUI tool to manage MongoDB.
Configure path:
Open Control Panel and go to System and Security> System.
Select "Advanced System Settings" and then click the "Environment Variables" button.


In the "System Variables" section, find and select the "path" variable, then click the "Edit" button.


Add the path to the bin folder of MongoDB (the default is C:\Program Files\Mongodb\Server\{Version}\bin), and click "OK".


Start MongoDB:
If you have chosen MongoDB settings as a service, it will automatically run after installation.
If you do not install MongoDB as a service, you can boot it by opening Command Prompt and running the following command:
$ mongod



Download MongoDB Command Line Database Tools .msi installer from the following link: MongoDB Command Line Database Tools
Open the .msi file downloaded to start the installation process. Click "Next" and "Install" when asked to install.


Check MongoDB Command Line Database Tools version with Command Prompt:
$ mongodump --version


- Install Redis: Reference: https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-windows/
Or use the unofficial version of Redis on Windows: https://github.com/microsoftarchive/redis/releases
Download .msi installer:


Open the .msi file downloaded to start the installation process. Click "Next" and "Install" when asked to install.


Connect to Redis:
Once Redis is running, you can test it by running redis-cli:
redis-cli
Test the connection with the ping command:

---

B. Installing services on Linux:

If you are using hosting: They will provide you all the credentials to access: FTP and Database account.
If you are using VPS (Ubuntu 22.x Recommended): Login to SSH server and install:
- B. Install Nginx: Reference: https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-22-04
System update:
$ sudo apt update


$ sudo apt upgrade


Install Nginx:
$ sudo apt install nginx


Start and activate Nginx:
$ sudo systemctl start nginx
$ sudo systemctl enable nginx


Check the status of Nginx:
$ sudo systemctl status nginx


- Install MongoDB: Reference: https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/
Import the public key used by the package management system:
$ sudo apt-get install gnupg curl


$ curl -fsSL https://www.mongodb.org/static/pgp/server-7.0.asc | \ sudo gpg -o /usr/share/keyrings/mongodb-server-7.0.gpg \ --dearmor

Create a list file for MongoDB:
$ echo "deb [ arch=amd64,arm64 signed-by=/usr/share/keyrings/mongodb-server-7.0.gpg ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb-org/7.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-7.0.list

Reload local package database:
$ sudo apt-get update


Install the MongoDB packages:
$ sudo apt-get install -y mongodb-org


Start and activate MongoDB:
$ sudo systemctl start mongod
$ sudo systemctl enable mongod

Check MongoDB status:
$ sudo systemctl status mongod



- Install Node.js: Reference: https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-22-04
Add Nodesource repository:
$ curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -


* Replace 18.x with the Node.js version you want to install. We recommend using Node.js 18.x or higher.
Install Node.js:
$ sudo apt-get install -y nodejs


Check Node.js version:
$ node --version
$ npm --version


Next step is to install "forever" using the following command:
$ sudo npm install forever -g


Check "forever" version:
$ sudo forever --version


Now, once "forever" is installed your server, we are ready to run our application.
- Install Redis: Reference: https://redis.io/docs/latest/operate/oss_and_stack/install/install-redis/install-redis-on-linux/
Add the repository to the APT index, update it, and install Redis:
$ sudo apt-get update
$ sudo apt-get install redis
Start Redis server:
$ sudo systemctl enable redis-server
$ sudo systemctl start redis-server
Connect to Redis:
Once Redis is running, you can test it by running redis-cli:
redis-cli
Test the connection with the ping command:

Configure Source Code

This is a general installation overview of the script.

Follow the steps as explained, and you will complete the installation process.

A. SOURCE CODE CONFIG

Open file .env.example and rename to .env located inside script folder.



MONGO_USER=""
MONGO_PASSWORD=""
MONGO_DB_NAME="kindiedb1"
* Replace "" with your database username, password and database name.

MAIL_AUTH_USER="no-reply@mg.kindie.io"
MAIL_AUTH_PASSWORD="Kd123123!"
MAIL_AUTH_HOST="smtp.eu.mailgun.org"
MAIL_AUTH_PORT="587"
MAIL_FROM="no-reply@mg.kindie.io"
* Replace "" with your maigun credentials you have when register on Mailgun.
* If you need to send / received email, we support Mailgun service, please replace all the credentials above by your Mailgun server config. Reference: https://documentation.mailgun.com/

TYPE_CACHE="file"
The default caching will be used with "file".
If you install Redis, you can change to "redis": TYPE_CACHE="redis"

Open file firebase-service-account-example.json and rename to firebase-service-account.json located inside script folder.

* If you need to submit notifications or messages, please replace all the authentication information above with the credentials you registered in Firebase. Reference: https://console.firebase.google.com/u/0/

Then Upload all files/folders located inside "script" folder to your server.

B. - START APPLICATION
How to start our application on dedicated server?
Login to your server using command line: $ cd /path/to/script
$ cd /path/to/web-kindie/
Note: You MUST go to working folder have source code to run the following commands.
Before we run our application, you need to install all the dependencies, to do that, run the following command and wait till it finishes.
$ npm install -g sails
$ npm install

To start our application, run the following command:
$ sails lift

Now your node server is running on PORT 1337.
Note: Kindie build on Sails JS Framework, so if you need further information how to config advanced, reference: https://sailsjs.com/get-started
To stop our application, press CTRL+ C
Run the following command using the server "forever" $ forever start app.js

Deployment

We recommend using this app in a Linux environment with the Nginx service.
If you are using Windows, please config with IIS service by yourself. Refer: Deploy React application

Run the application on Linux:

Config Nginx file:
You need 1 domain to configure: for ex: kindie.com
Download the sample file here: sample-api.conf
Replace the demo API domain name with your API domain name.
Replace demo root path folder with your root path folder.
Replace port with your port.

	server {
		##Replace kindie.com below by YOUR_DOMAIN_NAME##
		server_name kindie.com;
		client_max_body_size 10m;
		client_body_timeout 60;
	
		access_log off;
		error_log /var/log/nginx/kindie.com-error error;
	
		##Replace /var/www/html/kindie below by YOUR_ROOT_PATH to your document root (source code folder) on your server##
		root /var/www/html/kindie;
		index  index.html;
	
		### root directory ###
		##Replace port 1337 below by port you run NodeJS service##
		location / {
			proxy_pass http://127.0.0.1:1337;
			proxy_http_version 1.1;
			proxy_redirect off;
			proxy_set_header Upgrade $http_upgrade;
			proxy_set_header Connection 'upgrade';
			proxy_set_header Host $host;
			#proxy_cache_bypass $http_upgrade;
		}
	}									

Ensure that the Nginx configuration file is compatible with both the API domain and the main website domain.
$ service nginx restart
Visit the domain in a browser to verify.

Instructions for Using the Software on the Website Platform (Management Board)

Kindie helps schools to oversee and manage the activities of staff, parents, and students. It manages teaching programs, information flows, and school reports. Below is a guide for the management board on using the software on the website platform.

1. Logging into the Software

• Step 1: Access the software.
  Go to the Kindie administration website Here.
• Step 2: Sign in.
  In the Sign-in window, enter your Email and Password provided.
  Select Log In to sign in to the software.
  

2/ Set up school information

• Step 1:
  On the main interface of the software, click on the in the top right corner of the screen.
  Select Settings from the menu.
  
• Step 2: Fill in the information.
  
  
  1. General
  • Menu settings: Divide the time frames of the day

  Delete time frame ,
  Add time frame
  • Payment Method Settings: Select and fill in the information of the payment methods that you support.
  • Other Settings
  • Weekend: Divide the time frames of the day
  • Maximum size of file upload (MB): Divide the time frames of the day
  • Turn on shuttle bus on mobile application: If your school has a bus that takes students to school, turn it on to track the driver's pick-up/drop-off times.
  • Enable to modify time attendance on web: Divide the time frames of the day
  2. Web: Set up information on Website
  3. App: Set up information on mobile app
  4. Web Menu: Set up login screen interface
  5. Currency: Add the currency the school uses for payment
     Select Add new then fill in the currency information and select Add
     

3/ Create a branch

• Step 1:
  On the main interface of the software, click on the in the top right corner of the screen.
  Select Branch from the menu.
  
• Step 2:
  In the right-hand side Branch window, click on Add New.
  
• Step 3: Branch information.
  Fill in the information for the new branch in the provided form (1).
  Finally, click Add to complete the process. You can go to the Management section on the left side of the screen to verify the branch you just created.
  

4/ Create a new session

• Step 1:
  On the main interface of the software, click on Academy.
  Select Session from the options.
  In the right-hand side Session window, click on Add New.
  
• Step 2: Session information.
  Fill in the information for the new session in the provided form (1).
  Finally, click Add to complete the process.
  

5/ Creating a new group class

• Step 1:
  On the main interface of the software, click on Academy.
  Then select Class Groups.
  In the Group Class window on the right side, click on Add New.
  
• Step 2: Group Class Information
  Fill in the information for the new group class in the form (1).
  Finally, click on Add to complete.
  

6/ Creating a new class

• Step 1:
  On the main interface of the software, click on Academy.
  Then select Classes.
  In the Classes window on the right side, click on Add New.
  
• Step 2: Class Information
  Fill in the information for the new class in the form (1).
  Finally, click on Add to complete.
  

7/ Change class

• Step 1:
  On the main interface of the software, click on Academy (1).
  Then select Change Class (2).
  Use the search bar and filter the list to find students faster (3).
  After finding the student you need to transfer, select that student (4).
  Next, in section (5), select the class the student will be transferred to.
  Click Move to complete (6).
  

8/ Creating health examination schedule

• Step 1:
  On the main interface of the software, click on Academy.
  Then select Medical.
  In the Medical window on the right side, click on Add New.
  
• Step 2: Class Information
  Fill in the information for the health examination schedule in the form (1).
  Finally, click on Add to complete.
  

9/ Creating a new menu

• Step 1:
  On the main interface of the software, click Academy.
  Then select Foods.
• Step 2:
  In the Foods window on the right side, there are two options:
  • Add new: Add a single food item.
  • Action > Import data: Upload multiple food items at once (using the provided file template).
  
• Step 3: Food Information.
  • For Add new: Fill in all the food information in the form (1) and click Add new to save the food item.
    
  • For Import data:
    Select the English/Vietnamese file template.
    
    Open the downloaded excel file.
    Refer to the Manual sheet then fill in the menu information in the FoodData sheet.
    
    Finally, return to the website and import the file under Choose File.
    

10/ Creating a new subject

• Step 1:
  On the main interface of the software, click Academy.
  Then select Subject.
• Step 2:
  In the Subject window on the right side, there are two options:
  • Add new: Add a single subject item.
  • Action > Import data: Upload multiple subject items at once (using the provided file template).
  
• Step 3: Subject Information
  • For Add new: Fill in all the subject information in the form (1) and click Add new to save the subject item.
    
  • For Import data:
    Select the English/Vietnamese file template.
    
    Open the downloaded excel file.
    Refer to the Manual sheet then fill in the menu information in the SubjectData sheet.
    
    Finally, return to the website and import the file under Choose File.
    

9/ Adding new students

To add students to a class, follow these steps:

• Step 1:
  On the main interface of the software, click on Management.
  Select the branch that contains the class where you want to add student.
  In the branch window, click on the class where you want to add student.
  
• Step 2:
  In the Students window on the right side, there are two options:
  • Add new: just add one student
  • Action > Import data: Upload multiple students at once (using the provided file template).
  
• Step 3: Student Information
  • For Add New: Fill in the student's information in both forms Profile, Healthy Info and click Add new to save information.
    
  • For Import:
    Select the English/Vietnamese file template.
    
    Open the downloaded excel file.
    Refer to the Manual sheet then fill in the students' information on the StudentData sheet.
    
    Finally, return to the website and import the file under Choose File.
    

10/ Adding new parents

To add new parents, follow these steps:

• Step 1:
  On the main interface of the software, click on Management.
  Select the branch that contains the class where you want to add parent.
  In the branch window, click on the class where you want to add parent.
  
• Step 2:
  Select the Parents tab, there are two options:
  • Add new: just add one parent
  • Action > Import data: Upload multiple parents at once (using the provided file template).
  
• Step 3: Parent Information
  • For Add New: Fill in the parent's information in the form
    
  • For Import:
    Choose the English/Vietnamese template file.
    
    Open the downloaded excel file.
    Refer to the Manual sheet then fill in the parents' information on the ParentData sheet.
    
    Finally, return to the website and import the file under Choose File.
    

11/ Add user (Teachers, Drivers, Accountants, School Administrators)

• Step 1:
  On the main interface of the software, click on the located in the top-right corner of the screen.
  Select Users.
  
• Step 2:
  In the Staffs window on the right side, click on Add New.
  
• Step 3: Fill in the information.
  In the Staff window, fill in the information and assign the staff member's position according to the form (1).
  Finally, click on Add New to add the staff member.
  

12/ Posting new articles and news for the school

• Step 1:
  On the main interface of the software, click on News.
  Then select All News.
  In the Post window on the right side, click on Add New.
  
• Step 2: Class Information
  Fill in the information for the news in the form (1).
  Finally, click on Add New to complete.
  

13/ Send notifications to each Class/Parent/Teacher

Steps for the school to create and send notifications to parents and teachers.

• Step 1:
  On the main interface of the software, click on Information Portal.
  Next, select the Notifications section.
  
• Step 2:
  In the Notifications window on the right side, click on Add new.
  
• Step 3: Create content for the notification.
  Create a new notification using the form (1) and select the appropriate notification type (scope): All/Parents/Teachers.
  Finally, click Add new to send the notification.
  

14/ Create event

• Step 1:
  On the main interface of the software, click on Portal.
  Then select Event.
  In the Medical window on the right side, click on Add New.
  
• Step 2:
  fill in all information in the form (1).
  Finally, click on Add New to complete.
  

15/ Create albums

• Step 1:
  On the main interface of the software, click on Information Portal.
  Next, select the Album section. After the Albums window opens, click on the Add new button to start creating a new album.
  
• Step 2: Create a new photo album.
  Fill in the album information in the form (1) and upload the images.
  Finally, click Add new to complete the album creation. Now you have successfully created a photo album.
  

16/ Creating fees & notification invoice

First we need to create a list of fees (or fees that need to be collected).

• Step 1:
  On the software main interface, click Fee.
  Select the Fee section.
  In the Fee window, click Add new on the right side.
  
• Step 2: Fill in information about the new fee.
  Please fill in the information for the new fee such as name, amount,... according to form (1).
  Finally, click Add to add the fee to the list.
  
  Once created, the new fee will be displayed in the category as follows:
  

Next, we will create invoices for the objects from the created charges:

• Step 1:
  Select the Invoice section.
  In the Invoice window, click Add new on the right side.
  
• Step 2: Add new invoice.
  Invoice type options (1).
  Fill in the invoice information in section (2).
  
  Select the fee categories to collect from the pre-created list (1).
  Multiple fees can be collected in 1 invoice, select Add new (2) to add other categories to the invoice.
  Then select Continue to go to the next step.
  
• Step 3: Check the newly created invoice.
  Check and edit the invoice information in section (1).
  Save the invoice to complete invoice creation (2).
  
• Step 4: Send invoice notification.
  In the Invoice window there is a list of invoices that have been created. Here, you will select the invoice you want to send notification to.
  Select Sent to parent or Sent to parent and notification to send invoice notification to parents.
  

17/ View report

To view reports, select the Report section.
Select the report you want to view here there is report on Attendance and Expenses

• Attendance Report:
  Select the class and the time period you want to view the attendance report for (1).
  After selecting, click Filter (2) to view the report.
  
• Expense Report:
  

You can export the report by selecting Action > Export

18/ Manage buses and assign students to pick up students

Create new bus information

• Step 1:
  On the software main interface, click on in the right corner of the screen.
  Select the Bus section .
  
• Step 2: In the bus window that appears, select Add new.
  
• Step 3:
  Please fill in the new bus information as well as the driver's name(1).
  Finally, click Add new to add the bus to the system.
  

Assign students to pick up and drop off buses

• Step 1:
  In the list of buses, click on the bus icon of the bus you want to assign.
  
• Step 2: In the window a list of students will appear, select (2)students the bus will pick up. We can quickly search for students in the search bar (1).
  Finally, click Update to add students to the list of buses that will pick up.
  

19/ Messengers (exchange information, chat with classes)

Messengers
• Step 1:
  On the main interface of the software, click on Messengers.
  
• Step 2:
  In the opened window, choose the conversation you want to exchange information with (1).
  In the chat interface, enter the content you want to discuss in the Input message section and can send images or attached files.
  Finally, select the green arrow to send your message.
  

20/ Upload medias

• Step 1:
  On the main interface of the software, click on Academy.
  In the Medias window on the right side, click on Add New.
  
• Step 2: Upload medias
  Select the file to upload in section. Note that the file has a maximum upload file size 20MB. Enter image caption content in the Caption box.
  Select Add new (2) to complete the upload.
  

21/ Create courses

• Step 1:
  On the main interface of the software, click on Courses.
  Then select List.
  In the Courses window on the right side, click on Add New.
  
• Step 2: Courses Information
  Fill in the information for the courses in the form (1).
  Finally, click on Save to complete.
  

Guide for Mobile App for Parents, Teachers, and Drivers

1/ Installation & login to the Kindie App on your mobile device

• Step 1: Install Kindie
  You can easily find and download the Kindie app from the App Store and Google Play Store.
  
• Step 2: Login
  Open the Kindie app that you have installed.
  Choose your role as Parent/Teacher/Driver.
  Enter your Username and Password provided by the school.
  Click LOGIN to access the app.
  

For Parents

1/ Viewing menu

On the Home screen of the app, select Function > Menu.
Parents can view the menu for each meal of the day for their child. They can also review past menus from previous days, helping parents monitor their child's nutrition at school.

2/ Viewing the timetable

On the Home screen of the app, select Function > Timetable.
Parents can view the timetable of the day for their child. They can also review past timetable from previous days.

3/ Leave of absence

On the Home screen of the app, select Function > Day off.
Select the + icon to create a new absence.
You can see your absence history in section (*).
Parents will enter the leave details for their child, including the Timeline and Reason.
Finally, click Send to submit the absence to the teacher.

4/ Viewing the health

On the Home screen of the app, select Function > Health.
Parents can view full information about their children's health.

5/ Checking tuition fee

• Step 1: On the Home screen of the app, select Function > Tuition.
  Select the fee to pay (3)
  
• Step 2: Review tuition details
  Parents can review detailed information about the tuition fee, including the amount due, payment deadline, and any outstanding balance.
  Then select the bank you want to make payment to in List Of Bank (5) and select Continue to Pay
  
• Step 3:
  Proceed to payment according to the payment information displayed on the screen. After successful payment, select I have transferred money (8) to confirm.
  

6/ Viewing news

On the Home screen of the app, select Function > News.
Parents can view the latest news and updates from the school.
Select the news you are interested in to see the full content of that news.

7/ Medicine

On the Home screen of the app, select Function > Medicine.
Select the + icon to create a new medicine.
You can see your medicine history in section History.
Parents will enter the medicine details for their child, including the Time, Content, Add photo.
Finally, click Send to submit the absence to the teacher.

8/ Viewing activity images

On the Home screen of the app, select Function > Activity Images.
You can view photo albums of your children's activities at school.
Select the photo album you are interested. Here you can view and interact by dropping reactions, comments on the album.

9/ Following children's activities

On the Home screen of the app, select Function > Tracking.
Parents can track the time when their child enters/exits the classroom.

10/ Online exchange with teachers

On the Home screen of the app, select the Messages.
Here, choose the conversation you want to engage in.
In the chat interface, enter the content you want to discuss in the Input message section and can send images or attached files.
Finally, select the green arrow to send your message.

For Teachers

1/ Check leave application

On the Home screen of the app, select Function > Day off.index.html
You can manage leave requests from parents here.
You will approve leave requests by selecting Allow or Not Allow, the system will send your response notification to parents.

2/ View tuition

• Step 1: On the Home screen of the app, select Function > Tuition.
  Select the student you want to view (3)
  
• Step 2:
  Here the student's expenses are displayed. Select an expense to see details about that expense.
  

3/ Medicine

On the Home screen of the app, select Function > Medicine.
You can see the medicine sent by parents.

4/ Create activity album

On the Home screen of the app, select Function > Activity Images.
You can view photo albums of your children's activities at school.
Select the + icon to create a new album.

5/ Attendance

• Step 1:Choose the class for attendance
  On the Home screen of the app, select Function > Attendance.
  Select the class for attendance (3)
  
• Step 2:Take Attendance
  You can take attendance for your class here.
  In the "In" section, enable the function to confirm that students have arrived in class.
  Then confirm who brought the student to class (parent/driver) and select Confirm.
  And select Send notification to send attendance notification.
  
  In the "Out" section, enable the function to confirm that students have left class.
  Then confirm who picked up the student (parent/driver), add additional notes in the Note section (if any), and select Confirm.
  Finaly, select Send notification to send attendance notification.
  

6/ Online exchange with teachers

On the Home screen of the app, select the Messages.
Select the class/parent you want to chat.
In the chat interface, enter the content you want to discuss in the Input message section and can send images or attached files.
Finally, select the green arrow to send your message.

For Drivers

Attendance and status update when transporting students

• Step 1:Choose the class for attendance
  On the Home screen of the app, select Function > Attendance.
  Select the class for attendance (3)
  
• Step 2:Take Attendance
  You can take attendance for your class here.
  In the "In" section, enable the function to confirm the student you just picked up.
  And select Send notification to send attendance notification.
  
  In the "Out" section, enable the function to confirm the student you just dropped off.
  Finaly, select Send notification to send attendance notification.