Skip to content

Equipo-Proton/la-tribu-exploradora-backend

Repository files navigation

Project's name: Aña añerando la tribu exploradora

Table of contents

General info

This is a project made for Ciudad Industrial del Valle del Nalón, S.A.U. (VALNALÓN). A Web Application as a Game to help kids between 3 to 6 six years old to learn words and vocabulary while they are playing a game. As a software team we had to build an app that allows children to learn by doing through techonology.

Visual Design

Game

Technologies

Front End Back End Diseño y organización

Setup

To run this project, install it locally using npm.

Clone the project

  git clone https://github.com/Equipo-Proton/la-tribu-exploradora-frontend.git
  git clone https://github.com/Equipo-Proton/la-tribu-exploradora-backend.git

Go to the project directory

  cd la-tribu-exploradora-frontend

Install dependencies

  npm install

Start the server

   npm run dev

Versions

Our workflow in git was as follows, we all started from the Main branch with the same base. Implementations, changes and features were made in the Develop branch, they were tested in the Release branch and from Release versions with checkpoints were released and updated the Develop branch to continue development with all the features tested and thus not generate a cycle of bugs.

Requirements

  • App will have some administrators (teachers) and some users (student groups). One user is a group of students.
  • Teachers can choose what games are active.
  • Users only can play active games.
  • We will build a game.
  • Plain design. Adaptative design (children).
  • Responsive design (tablet, computer and digital board).
  • Project will be 100% scalable and we will can add more games.
  • Project will be 100% tested.

Game description

  • Game consists of numbers and letters.
  • Numbers available (0-9). Letters available (A-Z).
  • Admin's screen will start the game and users will have to guess the word, moving the letters.
  • Admin on their screen will decide if the answer is correct or wrong and the result will be visual.

General characteristics

Student Users

  • They should be registered by a teacher user
  • Your registration will have name, email and password
  • Once registered they will be able to access the waiting screen until the teacher starts the game

Teacher Users

  • Teacher users can register students
  • When you log in you will have access to your student panel
  • They will be able to edit, register and delete students from their panel
  • They may give way to the game to the students who have registered
  • You will have access to a game panel where you will receive the answers of the students
  • When a student finishes, the teacher can send a validation from his game panel
  • The teacher can restart or end the game

Admin

  • Admin can register teachers
  • The administrator will have a panel with all teachers
  • The administrator can edit, register and delete teachers from his panel
  • When a teacher is deleted, the students registered by this teacher will also be deleted

Work methodology

  • TDD, software test-driven development.
  • We use Agile methodology in a Scrum framework.
  • We separated the team into departments with front or back tasks, and we practised pair programming to connect the two parts of the project

Learnings

  • Create a web application from scratch with separated backend and frontend repository.
  • Creation of views by components and modals for animations.
  • Keyboard with draggable keys.
  • Creation of a role system for users.

Next steps

  • Caps button for the game keyboard
  • Sound on the keyboard when pressing a letter
  • Sound on the keyboard when receiving a notification
  • Upload to production (Railway and/or other hosting)
  • Implement modals for all notifications
  • New game

Documentation

Authors

Nombre Roll
Guillermo García Web Developer https://github.com/guillerdev97
Inma González Scrum Master https://github.com/mimateach
Juan Francisco Balseca Product Owner https://github.com/sudobuda
Kerim Ozkan Web Developer https://github.ozknkrm
Miguel Salvador Web Developer https://github.com/miguelsalvadorrguez85
Mario Jiménez Web Developer https://github.com/majifer

Acknowledgements

About

Proyecto pedagógico de Factoría F5 para Valnalón (backend)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages