Skip to content

Latest commit

 

History

History
120 lines (89 loc) · 3.53 KB

README.md

File metadata and controls

120 lines (89 loc) · 3.53 KB

Class Path 📚✨

Class Path is a Laravel-based web application designed to manage schools, class groups and subjects. This project simplifies school schedule administration by allowing an admin user to manage it.

Whether you're a developer exploring Laravel or an educational institution seeking streamlined management solutions, Class Path is here to provide a clear, scalable, and reliable foundation.

Features 🚀

1. Auth Verification 👤

  • Users can Log in and Sign up in the system.
  • Each user is tied to a specific school via the school_id attribute.

2. School Association 🏫

  • Schools are the core entities in Class Path, connecting users for easy tracking and management.
  • Each user is assigned to one school, ensuring organized data relations.

3. Laravel Excellence 🛠️

  • Built with Laravel, Class Path leverages Eloquent ORM for intuitive database management.
  • Uses migrations, seeders, and models to ensure robust and scalable development.

Getting Started ⚡

Prerequisites

  • PHP >= 8.0
  • Composer
  • Laravel >= 10.x
  • Database (e.g., MySQL, PostgreSQL, SQLite)

Installation

  1. Clone the repository:

    git clone https://github.com/freddysae0/school-calendar-tool.git  
cd class-path

  2. Install dependencies:

    composer install

  3. Set up environment variables:

    • Copy .env.example to .env: 
      cp .env.example .env
    • Configure your database and other settings in the .env file.

  4. Generate the application key:

    php artisan key:generate

  5. Run migrations and seed the database (if needed):

    php artisan migrate --seed

  6. Start the development server:

    php artisan serve

    Visit http://127.0.0.1:8000 to access Class Path.

Folder Structure 🗂️

Key directories in the Class Path project:

  • app/Models: Contains the User,School and other models with their relationships.
  • database/migrations: Houses database migration files for managing tables.
  • routes/web.php: Defines the application's web routes.
  • resources/views: Contains the front-end templates for the application.

Development Notes 📝

  • User-School Association: Each user has a school_id, representing a one-to-many relationship.
  • Validation: Requests are validated to ensure data integrity.
  • Scalability: The architecture is designed to accommodate additional features like roles, permissions, and school data analytics.

Future Features 🌟

  • School Dashboard: Insights and analytics for schools.

Contributing 🤝

Contributions are welcome! Feel free to:

  • Submit pull requests.
  • Open issues for bugs or feature suggestions.

To contribute:

  1. Fork the repository.
  2. Create a feature branch: 
    git checkout -b feature-name
  3. Commit your changes and push them: 
    git push origin feature-name
  4. Submit a pull request.

License 📄

Class Path is open-source and licensed under the MIT License.

Contact 📧

Have questions or feedback? Contact us at [email protected] or visit our GitHub page.

Start building your educational management system with Class Path today! 🎓