Get Started

Thanks for purchasing EduManage - School Management System Application

Please read the documentation carefully, and if you have any questions, please feel free to contact us. Most pages are accompanied by a video tutorial, it's recommended to check both, the video and the written Documentation.

Must Read this:

After purchase, You need to Download EduManage - School Management System project zip file.
It is suggested to setup the EduManage - School Management System Project by following these steps:
  • Download the EduManage - School Management System project zip file.
  • Extract the zip.
  • In these EduManage - School Management System project you will get an folder. Open that folder in VS-Code to run project.
  • Download the Postgre SQL database.

Install VS Code

To start these project,you need VS Code for your platform (Windows, macOS and Linux).

Visual Studio Code is a lightweight but powerful source code editor which runs on your desktop and is available for Windows, macOS and Linux. It comes with built-in support for JavaScript, TypeScript and Node.js and has a rich ecosystem of extensions for other languages and runtimes (such as C++, C#, Java, Python, PHP, Go, .NET). Begin your journey with VS Code

Install Node Js

In order to start configuration, you need to install Node js and NPM. First download the Node js and NPM from here Node and NPM

Install Node js on Window

First, you need to download the Windows Installer (.msi) file from the official Node.js website. This MSI installer database carries a collection of installer files essential to install, update, or modify the existing Node.js version.and more information visit onhttps://kinsta.com/blog/how-to-install-node-js/

Notably, the installer also carries the Node.js package manager (npm) within it. It means you don’t need to install the npm separately.

When downloading, select the correct version as per your operating system. For example, if you’re using a 64-bit operating system, download the 64-bit version, and if you’re using the 32-bit version, download the 32-bit version:

Once you open and run the .msi file, the installation process begins. But you have to set a few parameters before running the installation process. Double-click on the installer file and run it. The installer will ask you to accept the Node.js license agreement. To move forward, check the “I accept” box and click Next:

Then, select the destination where you want to install Node.js. If you don’t want to change the directory, go with the Windows default location and click the Next button again.

The next screen will show you custom setup options. If you want a standard installation with the Node.js default features, click the Next button. Otherwise, you can select your specific elements from the icons in the tree before clicking Next:

Node.js offers you options to install tools for native modules. If you’re interested in these, click the checkbox to mark your preferences, or click Next to move forward with the default:

Lastly — and this is the easiest part of all — click the Install button to begin the installation process:

So the installation process is completed. Now, you have to check whether Node.js is successfully installed or not.

  • To verify the installation and confirm whether the correct version was installed, open your PC’s command prompt and enter the following command:
    • Node --version
  • And to check the npm version, run this command:
    • npm --version

if the Node.js version and npm are correctly installed, you’ll see the version name in the CMD prompt.!

Install Node js on MacOS

As our first step, we need to actually get the official installer for Node.js on macOS. To do so, we can head over to the Node.js Downloads page to download the installer.and more information visit on https://kinsta.com/blog/how-to-install-node-js/

Follow these steps to get started:

You can get the macOS installer by clicking the Macintosh Installer option - this will download the .pkg installer for Node.js. Make sure you save it somewhere that you'll be able to access it!

Now that you've got the installer downloaded, you'll need to run it. The installer is a pretty typical interface - it won't take long to get through it (under a minute), even though there are a few parts to it. You can get through it by following the guide below:

  • Introduction
    • Select Continue
  • License
    • Select Continue
    • Select Agree
  • Installation Type
    • Select Install
    • Authenticate with your Mac to allow the Installation
    • Select Install Software
  • Summary
    • Select Close

To verify that Node.js was installed correctly on your Mac, you can run the following command in your terminal:.

  • node -v

Update Your npm Version

  • $ sudo npm install npm --global

Start building with Node.js!

Install Node js on Linux

The Linux operating system works a bit differently than the other traditional operating systems. That’s because Linux is open-source, offering you more freedom, customization, and advanced functionalities. https://kinsta.com/blog/how-to-install-node-js/

If you’re casual with commands, you should feel comfortable with Linux. Here, we are about to discuss the easiest method of installing Node.js on the Linux operating system.

The Linux operating system has hundreds of different distributions because of the diversity it provides. And users love to customize and harness different versions’ specific functionalities using distinct distributions.

Firstly, find the installation instruction for your specific distribution from Node.js’s Binary Distributions page. For this guide, we’ll be using Ubuntu for illustration purposes.

  • Install Curl Command Line Tool
    • Before going for Node.js installation, ensure that you have the curl command-line utility installed on your system. If not, then paste this command on your terminal to install curl:
    • sudo apt install curl
  • It may ask for your system password to verify the permission of the installation. Once you input the password, the system should begin the curl installation.
    • Password for codebind:

You need to copy and paste the Node.js installation command into your terminal (in our case, we can grab it from the Ubuntu distribution page) so that the system can begin the Node.js installation.

For instance, here, we’ll be installing Node.js v14.x. These are the installation commands for Ubuntu:

  • Install Curl Command Line Tool
    • curl -fsSL https://deb.nodesource.com/setup_14.x | sudo -E bash -
    • sudo apt-get install -y nodejs

As you already have the curl command line installed on your terminal, you’ll need to copy and paste the first command (the curl command) on your terminal and run it.

These commands should display the version numbers for Node.js and npm, respectively.

The curl command begins the Node.js installation process, updates your system, and downloads all Node.js libraries required to install Node.js on your Linux OS.

  • Copy and paste the second line of command from the installation instructions above into your Linux terminal:
    • sudo apt-get install -y nodejs

As you’ve installed Node.js, you can verify to check whether the installation is successful or not. To confirm the installation, you need to run two simple Linux commands on your Linux terminal.

  • To check the Node.js version, type:
    • Node --version
    • npm --version

Install React Js

In order to start configuration, you need to install Node js and NPM. First download the Node js and NPM from here Node and NPM

Install React js on Windows

In this section, we’ll guide you through the process of installing Next on a Windows machine.

To publish and install packages to and from the public npm registry or a private npm registry, you must install Node.js and the npm command line interface using either a Node version manager or a Node installer. We strongly recommend using a Node version manager like nvm to install Node.js and npm. We do not recommend using a Node installer, since the Node installation process installs npm in a directory with local permissions and can cause permissions errors when you run npm packages globally.

Follow these steps to get started:

Before installing npm, you need to have Node.js installed on your system.

After the installation is complete, you can verify that Node.js and npm are installed by opening a command prompt and running the following commands:

  • node -v
  • npm -v

These commands should display the version numbers for Node.js and npm, respectively.

  • To download the latest version of npm, on the command line, run the following command:
    • npm i or npm install

Install React js on macOS

In this section, we’ll guide you through the process of installing React on a macOS machine.

As with the Windows installation process, you need to have Node.js and npm (Node Package Manager) installed on your macOS system as well. If you haven’t already installed them, follow these steps

Visit the Node.js download page

  • Visit the Node.js download page
  • Download the macOS installer

Once downloaded, click the .pkg file in your Downloads folder to run the installer

Follow the instructions that appear on your screen, including accepting the License Agreement, selecting the target destination for the installed files, and selecting the installation type.

After the installation is complete, you can verify that Node.js and npm are installed by opening a terminal and running the following commands:

After the installation is complete, you can verify that Node.js and npm are installed by opening a command prompt and running the following commands:

  • node -v
  • npm -v

These commands should display the version numbers for Node.js and npm, respectively

Alternatively, you can install Node.js and npm via the command line. To do this, open Terminal then input:

  • brew install node

Wait for the installation to complete then verify its installation in the same way as above, by entering:

  • node -v
  • npm -v

These commands should display the version numbers for Node.js and npm, respectively.

  • To download the latest version of npm, on the command line, run the following command:
    • npm i or npm install

Install React js on Linux

In this section, we’ll guide you through the process of installing React on a Linux machine.

Follow these steps to get started:

If you have a Linux-based system, you’ll want to follow this set of steps to install React:

  • sudo apt install npm

After the installation is complete, you can verify that Node.js and npm are installed by opening a command prompt and running the following commands:

  • npm --version
  • node --version

These commands should display the version numbers for Node.js and npm, respectively.

  • To download the latest version of npm, on the command line, run the following command:
    • npm i or npm install

Install PostgreSQL

PostgreSQL is a powerful, open-source object-relational database system with more than 30 years of active development. It is known for reliability, robustness, and performance.

You can download PostgreSQL from the official website: https://www.postgresql.org/download/

Install PostgreSQL on Windows

To install PostgreSQL on Windows, follow these steps:

  • Go to the official PostgreSQL download page and select Windows.
  • Download the installer provided by EnterpriseDB.
  • Run the installer and follow the setup wizard.
  • During installation, set a password for the default PostgreSQL superuser account (postgres).
  • Select the components you want to install (PostgreSQL Server, pgAdmin, Stack Builder).
  • Complete the installation and launch pgAdmin to manage your database.

After installation, verify PostgreSQL by opening Command Prompt and running:

  • psql --version

This should display the installed PostgreSQL version.

Install PostgreSQL on macOS

To install PostgreSQL on macOS, you have two main options: download the installer or use Homebrew.

Option 1: Using the Installer
  • Go to the PostgreSQL macOS download page.
  • Download the .dmg installer provided by EnterpriseDB.
  • Run the installer and follow the on-screen instructions.
Option 2: Using Homebrew (Recommended)
  • Open Terminal.
  • Run the command:
    • brew install postgresql
  • After installation, start the PostgreSQL service:
    • brew services start postgresql

Verify installation:

  • psql --version

This should display the installed PostgreSQL version.

Install PostgreSQL on Linux

PostgreSQL can be installed easily on most Linux distributions using the package manager.

For Ubuntu/Debian:
  • Update package list:
    • sudo apt update
  • Install PostgreSQL:
    • sudo apt install postgresql postgresql-contrib
  • Check version:
    • psql --version
For CentOS/RHEL/Fedora:
  • Enable PostgreSQL repository (if required).
  • Install PostgreSQL:
    • sudo dnf install postgresql-server postgresql-contrib
  • Initialize database:
    • sudo postgresql-setup initdb
  • Enable and start PostgreSQL:
    • sudo systemctl enable postgresql
    • sudo systemctl start postgresql

After installation, you can switch to the default postgres user and start the PostgreSQL shell:

  • sudo -i -u postgres
  • psql

Setup Supabase

EduManage uses Supabase as the backend for PostgreSQL database, authentication, file storage, and real-time features. You must set up Supabase before running the project.

Option 1: Local Supabase (Recommended for Development)

Use Supabase CLI to run PostgreSQL, Auth, Storage locally using Docker.

  1. Install Supabase CLI:
    npm install -g supabase
  2. Login to Supabase CLI:
    supabase login
    (Use your Supabase account or skip if using anonymously)
  3. Initialize Supabase in your project root:
    supabase init
  4. Start local Supabase services:
    supabase start

After starting, you’ll see output like:

API URL: http://localhost:54321
DB URL: postgresql://postgres:postgres@localhost:54322/postgres
anon key: eyJhbGciOiJIUzI1NiIs...
project ID: local
      

Option 2: Use Supabase Cloud (Production/Remote)

  1. Go to https://app.supabase.com and create a new project.
  2. After project is ready, go to Settings > API and copy:
    • URL (e.g., https://xyz.supabase.co)
    • anon public key
  3. Database connection: postgresql://postgres:[YOUR-PASSWORD]@[HOST]:5432/postgres

Add Supabase Keys to Environment (.env.local)

Create a .env.local file in your project root:

# .env.local
NEXT_PUBLIC_SUPABASE_URL=http://localhost:54321
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJhbGciOiJIUzI1NiIs...
SUPABASE_SERVICE_ROLE_KEY=your-service-role-key-from-supabase-dashboard (optional, for server-side)

Never commit .env.local to Git! Add it to .gitignore

Initialize Supabase Client (in your code)

Make sure you have this in lib/supabaseClient.ts or similar:

import { createClient } from '@supabase/supabase-js'

const supabaseUrl = process.env.NEXT_PUBLIC_SUPABASE_URL!
const supabaseAnonKey = process.env.NEXT_PUBLIC_SUPABASE_ANON_KEY!

export const supabase = createClient(supabaseUrl, supabaseAnonKey)

Start-project

In VS-Code, project folder will be open in new tab with integrated terminal to run commands.

Front-End / Backend

Once the project is setup, head over to the project directory by running the following command in the command prompt:

  • npm run dev

This command launches the development server, which watches for changes to your project files and automatically reloads the browser when changes are detected.

A new browser window should open with your Next.JS application running at http://localhost:8080/ that looks like this:

Above illustration demonstrates the process to start the project of Frontend.

Congratulations! You have successfully run Next.JS project on your machine. You can now begin building your user interfaces with Next.

DashBoard View

After the successfully login, you will be redirect to Dashboard page.

Above illustration demonstrates the project of dashboard UI.

Change App Title Name

If you want to change the name of these project you just have to add the metadata function which implements the Metadata interface coming from "next" library (line 5) in that specific page and give title and description inside it.

Above illustration demonstrates the process to change the name of application.

Change App Menu

If you want to change name of menu go to title option and change the title on particular screen.

Above illustration demonstrates the process to change the Menu of application.

Change App Routing

If you want to change url of routing just rename that folder or create a new folder in the app folder (Next.JS 13+).

Above illustration demonstrates the process to change the Routing of application.

Error

  • Input Errors:
    • Information provided by the user is unacceptable for some reason. This includes errors from form validation, duplicate actions, uniqueness issues, resources not found, etc.
  • Authorization Errors:
    • A user is attempting to perform an action to which he/she does not have permission
  • Availability Errors
    • A resource that is needed to complete the user's action is unavailable for some reason. This may be expected (scheduled maintenance) or unexpected (server crash!).
  • Unexpected Errors:
    • These are errors that likely indicate a bug in the application, such as unhandled exceptions.

And More information go to the Horse Hub README.md file and Read more information to these projects