Project: "School notes"

1. Project description:

• The client is a school that has asked us for an app to manage its students data and scores.
• Students will be able to view their exams marks.
• Their teacher will be able to add, modify and delete both students and their marks.

2. User stories:

2.1 User Story (User):

• See the page.
• They can see their marks.
• They can see their information.

2.2 User Story (Administrator):

• View the app as admin.
• Access their student information and marks.
• Add new students and marks.
• Delete students and marks.
• Edit students and marks.

3. Team Members

Name	Role
Paloma Ruíz	Scrum Master	https://github.com/birdsinyourgarden
Alba Rus	Product Owner	https://github.com/Albaric0que
Camila Ruíz	Developer	https://github.com/camilaruiz17
Himorell Jaramillo	Developer	https://github.com/Himorell
Raquel Palomo	Developer	https://github.com/raquel2002x

4. Atomic Design

5. Final Design

Login	Home View	Student View	Student Show View	Score View

6. Stacks

• HTML5
• CSS3
• JavaScript
• PHP 8.1.10
• Laravel
• Boostrap 5
• DrawSQL
• MySQL

7. Required:

Composer & Laravel Installed

XAMPP/LAMPP Installed

NPM Installed

MySQL

PHP

PHP Artisan Serve

8. How to install this project:

You will need a text editor and perform the following steps:

1. Clone the project

  git clone https://github.com/Himorell/springfieldElementarySchool

2. Go to the project directory

  cd springfieldElementarySchool

3. Create a MySQL database named "springfieldelementaryschool"

4. Locate .env.example in the project and once there change the database name that comes by default for our database name (laravel for springfieldelementaryschool). After that, remove .example from the file name so its new name will be .env

5. Install dependencies

  npm install

  composer install

6. Activate the server and keep this terminal open

  npm run dev

7. Run the PHP server and keep this terminal open

  php artisan serve

8. Import database

  php artisan migrate:fresh --seed

---

9. Tests

To run the php tests, execute the following command(s)

  php artisan test

To run the vendor tests, execute the following command(s)

  vendor/bin/phpunit

10. Methodology:

• Mob programming.
• Pair programming.
• Agile with SCRUM
• TDD

11. Next Steps

• Conexión Cloudinary con BBDD.
• Cerrar trimestre y año escolar.
• Vista por asignaturas.
• Enviar email de notas y recuperación.
• Test de notas.
• Mejorar el estilo de las vistas.
• En portada mostrar todo el alumnado con las asignaturas y sus notas y con la media por trimestre.
• Integrar roles y permisos para la gestión de notas