README.md

Sekoliko build status :

School Management Web Application OPENSOURCE

Requirements

- composer
- node && yarn
- php > 7.2
- symfony cli (link to download: https://symfony.com/download)
- motivation
- basics of symfony & php
- basics of Javascript

Usage

Step 1. Fork this project

Step 2.

- git clone https://github.com/[your_username]/sekoliko.git

Step 3. Create new branch [optional] (if you want to contribute)

- git checkout -b feature/my-branch

Step 4. Install composer dependencies

- composer install

Step 5. Install node dependencies

- yarn install

Step 6. Create new database then, create new file .env.local, add .env content to this and configure DATABASE_URL in .env.local to follow your own database configuration like :

- DATABASE_URL="mysql://db_user:[email protected]:3306/db_name?serverVersion=5.7"

Step 7. Update database schema

- bin/console doctrine:schema:update --force

Step 6. Run server

- symfony serve

Step 7. Run webpack server for assets

- yarn encore dev --watch

Create your first user by running :

php bin/console sekoliko:create:super-admin

For new school and admin run :

php bin/console sekoliko:create:admin

STANDARD

Code must follow symfony coding standard style,Install this coding standard in your root directory of sekoliko.

git clone git://github.com/djoos/Symfony2-coding-standard.git && composer install -d ./Symfony2-coding-standard
./Symfony2-coding-standard/vendor/bin/phpcs --config-set installed_paths ../../../../Symfony2-coding-standard

Then run this command ALWAYS and fix all errors before your push.

./Symfony2-coding-standard/vendor/bin/phpcs --standard=Symfony --ignore=*/vendor/*,/src/Kernel.php,*/Migrations/* ./src/

Design

Make cool and user friendly design, we have a template named admirator inside assets directory for theme.

Git

Commit convention :

• All commit MUST be tagged with one of the following tags : [bug] / [fix] / [feature] / [design] / [packages] / [wip]
• DON'T create merge request for unstable developpment.
• All code must be passed with TU/TF.

Goal

• SaaS (Software as a Service ) App for School/University in Madagascar
• Online course
• Online report
• Fee management
• Student/Teachers/Administration management ( attendance, year sumary )
• Classroom management for thos school who doesn't have fixed room.

NON Goal

• Online university.

---

Make cool things 😉

---

Contributors ✨

Thanks goes to these wonderful people :

SylvanoTombo 💻	RinaVatosoa 🎨	nyantso 💻	Fy Kely 💻 🎨	Chrys Rakotonimanana 💻	Jul 📆 👀 ⚠️ 💻	Hantsaniala Eléo 🎨
Tolotra Raharison 💻	Vony Randria 💻	rhianmax 💻	Henintsoa Harinoro 🌍	Mika Andrianarijaona 💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome !