Get Started

The Idea

Building a school automation platform like these real-world products:

1. OpenEduCat - Open source education management
2. Pioneers E-School - Comprehensive school system
3. PowerSchool - $2.8B valuation, 45M students
4. Infinite Campus - 7.8M students, 50 US states

See more companies at Competitors.

Localhost Setup

01. Install VS Code

Download from code.visualstudio.com

02. Install Node.js

Download from nodejs.org (LTS version)

03. Install Git

Download from git-scm.com

04. Open VS Code

Launch VS Code, then open terminal: View → Terminal

05. Install pnpm

pnpmnpmyarnbun
pnpm add -g pnpm
Copy

06. Clone the repository

Copygit clone https://github.com/databayt/hogwarts.git

07. Open project in VS Code

File → Open Folder → select the hogwarts folder

08. Open terminal in VS Code

View → Terminal or Ctrl + `

09. Install dependencies

Copypnpm install

10. Create environment file

Create .env in root folder and paste the content from WhatsApp group

11. Generate Prisma client

Copypnpm prisma generate

12. Setup database

Copypnpm prisma migrate dev

13. Start dev server

Copypnpm dev

14. Open browser

Go to http://localhost:3000

For detailed setup, see Localhost Setup.

First Good Issue

Add your name to the blog page as your first contribution.

01. Create a new branch

Copygit checkout -b feat/your-name

02. Open the file

Open src/components/marketing/blog/content.tsx in VS Code

03. Find the Blog text

Look for this code:

Copy<div>
    Blog
</div>

04. Add your name below Blog

Change it to:

Copy<div>
    Blog
    <p>Your Name</p>
</div>

05. Save the file

Press Ctrl + S

06. Stage changes

Copygit add .

07. Commit changes

Copygit commit -m "feat: add Your Name to blog"

08. Push to GitHub

Copygit push origin feat/your-name

That's it! Welcome to Hogwarts.

Next Steps

Browse the Demo to assess current progress. Open issues for bugs you find, or create sub-issues if a related issue already exists.

Login: admin@databayt.org / 1234

Explore the Docs

• MVP - Minimum viable product
• Contributing Guide - How to contribute
• Architecture - System design
• Pattern - Code patterns

Join the Community

• Browse open issues on GitHub
• Join our Discord server