Repository files navigation

This is thefrontend for theEdTech SaaS platform, a web-based application that facilitates communication between School Admins, teachers and students. The platform provides a dashboard for trackingacademic performance, event updates, and attendance records.

The frontend is built usingNext.js, ShadCN UI, and TailwindCSS, offering a seamless user experience with a modern UI. It integrates withAppwrite for authentication and data storage, andPermit.io for authorization.

• User Authentication & Role Management: Powered byAppwrite for authentication andPermit.io for fine-grained role-based access control (RBAC).
• Multi-Tenant Support: Schools can manage their own students, teachers, and school Administrators within their unique environments.
• Student & Assignment Management: Teachers can add students and assignments, track academic progress, and share performance reports.
• Mobile-Responsive UI: Built withTailwindCSS for a fully responsive experience.
• Containerized Deployment: Dockerized for ease of deployment and scalability.

• Frontend Framework: Next.js
• UI Components: ShadCN, TailwindCSS
• Authorization: Permit.io
• Authentication & Backend Services: Appwrite (for database & API integration)
• State Management: Zustand (with persistence enabled)
• Containerization: Docker

Ensure you have the following installed:

• Node.js (v18+)
• pnpm (preferred) or npm/yarn
• Permit Account
• Appwrite Project ID
• Docker (for containerized deployment, optional)

Clone the repository and install dependencies:

# Clone the repositorygit clone https://github.com/your-repo/edtech-frontend.gitcd edtech-frontend# Install dependenciespnpm install# or npm install / yarn install

Create a.env.local file in the root directory and configure the following:

NEXT_PUBLIC_APPWRITE_PROJECT_ID=your-appwrite-project-idNEXT_PUBLIC_APPWRITE_ENDPOINT=https://your-appwrite-instanceNEXT_PUBLIC_PERMIT_API_KEY=your-permit-api-key

Start the development server:

pnpm dev# or npm run dev / yarn dev

The application will be available athttp://localhost:3000.

The application Backend will be available athttp://localhost:8080.

To generate an optimized production build:

pnpm build# or npm run build / yarn build

To start the production server:

pnpm start# or npm start / yarn start

To run the app inside a Docker container:

docker build -t edtech-frontend.docker run -p 3000:3000 edtech-frontend

We welcome contributions! Please follow these steps:

1. Fork the repository and create a new branch.
2. Implement your feature or fix.
3. Ensure all tests pass (pnpm test).
4. Open apull request with a detailed description of your changes.

If you encounter any issues, feel free to open an issue in the GitHub repository or reach out to the maintainers.

This project is licensed under theMIT License. SeeLICENSE for more details.