Edust | Education Student Teacher

Overview

Edust is a web application designed to enhance educational collaboration and interaction between students, teachers, and educational institutions. It provides features for user registration, organization page creation, and customization using a page builder tool.

Features

Our platform allows users to create accounts and authenticated users to create organizations. Public users can view organization sites built by organization creators, which mainly consist of educational institutions such as schools, colleges, and universities.

Technologies Used

• Frontend: React.js, TypeScript

Getting Started

To get a local copy up and running, follow these steps:

1. Clone Repository:

   git clone https://github.com/edust-org/edust.git
   cd edust

2. Install Dependencies:

   pnpm install

3. Setup Environment Variables: Create a .env file in the root directory and add necessary environment variables.

4. Run the Application:

   pnpm run dev

5. Access the Application: Open your web browser and navigate to http://localhost:5173.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the project.
2. Create your feature branch (git checkout -b dev).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin dev).
5. Open a pull request.

License

Distributed under the MIT License. See LICENSE for more information.

This README provides a structured overview of the Edust project, focusing on user registration, organization page creation, and customization features as per your requirements. Adjustments can be made based on further project developments or specific user needs.