Giter VIP home page Giter VIP logo

femcole's Introduction

logoFemCole

FemCole - an innovative app created to manage teachers' classes 👩‍🏫

A Spanish speaking school required an app to manage teachers' classes and that's how FemCole was created. This innovative app allow for teachers watch a list of all of their students and student's grades for each trimester and exam.

At the beggining of the school year, teachers can register their students on the app and then, students can log in using their email and password. This way, students only can watch their grades on their profile. If grades are lower than five they are gonna be red (fail), and if grades are 10 they are gonna be purple (pass).

Teachers also can register student's grades as the school year progress and watch the whole studdent's profile, averages included. Both students and grades can be edited or deleted by the theacher if it's necessary.


Table of contents


Team Members

Name Role
Paloma Babot Scrum Master https://github.com/Uxoa
Adriana Aguilar Product Owner https://github.com/adrianaguilaruiz
Ana Rueda Developer https://github.com/anaruedaguiu
Beatriz de Ávila Developer https://github.com/Beadeavila
Esther de Luque Developer https://github.com/EstherAma
Paula Ramírez Developer https://github.com/pagudelo884

Screenshots

Sketchs views teacher

Sketch Login View Desktop Teacher Sketch Homepage View Desktop Teacher

Sketchs views student

Sketch Login View Mobile Student Sketch Show View Desktop Student Sketch Show View Mobile Student

Mockups views teacher

Mockup Login View Desktop Teacher Mockup Login View Desktop Teacher Mockup Register Student View Desktop Teacher Mockup Edit View Desktop Teacher Mockup Show View Desktop Teacher

Mockups views student

Mockup Show View Mobile Student Mockup Show View Mobile Student


Stacks

  • HTML 5
  • CSS 3
  • BootStrap 5
  • PHP 8.1.10
  • Laravel Framework 9.44.0
  • MySQL
  • DrawSQL

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/adrianaguilaruiz/femcole
  1. Go to the project directory
  cd femcole
  1. Start MySQL service and create a MySQL database named "femcoledb"

  2. Create in the text editor an .env file by copying the contents of .env.example and modify the database name (laravel by femcoledb)

  3. Install dependencies

  npm install
  composer install
  1. Activate the server and keep this terminal open
  npm run dev
  1. Run the PHP server and keep this terminal open
  php artisan serve
  1. Migrate database
  php artisan migrate:fresh --seed

Tests

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

  php artisan test

test_artisan_femcole

  vendor/bin/phpunit tests

test_vendor_femcole


Methodology

  • TDD
  • Agile with Scrum
  • Mob and pair programming

Next Steps

  • Completing the CRUD of the grades
  • Add functionalities (quarter end, calculation of average grades, ...)
  • Profiling the design with CSS
  • Configure all the views
  • Add Drag and Drop for student photos
  • Fixing the send student's email

femcole's People

Contributors

adrianaguilaruiz avatar anaruedaguiu avatar beadeavila avatar uxoa avatar pagudelo884 avatar estherama avatar

Forkers

uxoa

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.