Skip to main content

Introduction

Welcome to the eClassify documentation! This guide will help you set up and use eClassify, a comprehensive classification system.

What is eClassify?​

eClassify is a powerful classification platform that helps you organize and categorize content effectively. It includes:

  • Admin Panel
  • Mobile Application
  • Web Application

Getting Started​

The documentation is organized into several sections:

  1. Admin Panel Setup - Instructions for setting up and configuring the admin panel
  2. Mobile Application Setup - Guide for setting up and customizing the mobile app
  3. Web Application Setup - Steps to configure and deploy the web application
  4. Support - How to get help and contact information

Thank you for choosing eClassify!

Prerequisite​

For Web​

  1. VPS Hosting: A Virtual Private Server (VPS) is mandatory to ensure reliable performance and security. Shared hosting environments are not supported for this web application.
  2. Node.js Support: The server must support Node.js, as it is essential for running the application.
  3. Memory Requirements: The server should have at least 3-4 GB of free RAM to handle the application's processes effectively.
  4. SSH Root Access: The server must provide SSH root access to execute Node.js commands and manage the application.

For Admin Panel​

  1. PHP Version: Eclassify Admin panel is built using Laravel Framework 10.0 so you need PHP version minimum 8.1.0 or higher version installed on your server.

For App​

  1. Flutter Version: Flutter stable channel 3.29.2 sdk version
  2. Java Version: JDK version 22

Note: A VPS server is only required if you plan to use the web application. For hosting the web app, a VPS server is mandatory to ensure proper functionality and performance. However, if you are only using the mobile app and the admin panel, you can opt for a shared hosting server as it is sufficient for these components.

Getting Started​

Get started by creating a new site.

Or try Docusaurus immediately with docusaurus.new.

What you'll need​

  • Node.js version 18.0 or above:
    • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Generate a new site​

Generate a new Docusaurus site using the classic template.

The classic template will automatically be added to your project after you run the command:

npm init docusaurus@latest my-website classic

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

Start your site​

Run the development server:

cd my-website
npm run start

The cd command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The npm run start command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open docs/intro.md (this page) and edit some lines: the site reloads automatically and displays your changes.