https://github.com/josepostiga/syllabus

School Management System built with students, parents, and teachers, in mind.
https://github.com/josepostiga/syllabus

api docker laravel php school-management

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/josepostiga/syllabus
• Owner: josepostiga
• License: other
• Created: 2021-07-18T08:00:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-07T18:39:34.000Z (almost 3 years ago)
• Last Synced: 2023-06-03T15:26:13.687Z (over 1 year ago)
• Topics: api, docker, laravel, php, school-management
• Language: PHP
• Homepage: https://josepostiga.com/tag/syllabus/
• Size: 1.43 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
> This project is still in active development!

# Syllabus

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

![Run tests](https://github.com/josepostiga/syllabus/workflows/Run%20tests/badge.svg)

[![Coverage Status](https://coveralls.io/repos/github/josepostiga/syllabus/badge.svg?branch=main)](https://coveralls.io/github/josepostiga/syllabus?branch=main)

## 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](https://github.com/josepostiga/syllabus/discussions/categories/support) to ask for help.

## Testing

This project is fully tested. We have an [automatic pipeline](https://github.com/josepostiga/syllabus/actions) and an [automatic code quality analysis](https://coveralls.io/github/josepostiga/syllabus) 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:

``` bash

.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](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Security

Please see [SECURITY](SECURITY.md) for details.

## Credits

- [José Postiga](https://github.com/josepostiga)

- [All Contributors](../../contributors)

## License

The MIT License (MIT).