josepostiga / syllabus

School Management System built with students, parents, and teachers, in mind.

This project is still in active development!

Syllabus

A School Management System built with students, parents, and teachers, in mind.

Installation

If you have Make installed in your computer, simply run make install on your terminal. Otherwise, follow the instructions bellow:

1. Clone this repository.
2. Run .bin/composer install
3. Run cp .env.example .env
4. Run .bin/php artisan key:generate
5. Run cp docker-compose.override-example.yaml docker-compose.override.yaml
   1. If you already have a webserver (like Apache, NGINX, or other), simply route the traffic to the project's web-server container. If not, you can edit the docker-compose.override.yaml file and add the necessary ports mapping to bind your host's ports to the container's.
6. Run docker-compose up -d
7. Run NETWORK=syllabus .bin/php artisan migrate
8. Run NETWORK=syllabus .bin/php artisan accounts:create-user to create the first Director account and log into the application.

If you have any problems, refer to the Discussions Support category to ask for help.

Testing

This project is fully tested. We have an automatic pipeline and an automatic code quality analysis tool set up to continuously test and assert the quality of all code published in this repository, but you can execute the test suite yourself by running the following command:

.bin/php.sh vendor/bin/phpunit

Note: This assumes you've run .bin/composer.sh install (without the --no-dev option).

We aim to keep the main branch always deployable. Exceptions may happen, but they should be extremely rare.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

Please see SECURITY for details.

Credits

• José Postiga
• All Contributors

License

The MIT License (MIT).