Giter VIP home page Giter VIP logo

rk181 / familypoints-tfg-2023-24 Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 38 KB

Main repository of FamilyPoints project. The Final Year Project at the University of Alicante 2023-24

Home Page: https://rk181.github.io/FamilyPoints-TFG-2023-24/

License: MIT License

HTML 100.00%
api-rest final-year-project ionic-react laravel mobile-app tfg universidad-de-alicante university-of-alicante

familypoints-tfg-2023-24's Introduction

FamilyPoints (TFG 2023-24)

Overview

This project is a cross-platform mobile application to manage the exchange of favors/tasks between members of the same family, couple-oriented, (staying one night with the children, cooking for the whole week, etc.), which will be accumulated as points redeemable for activities/rewards (free night with friends, spa, afternoon video games, etc.).

It is built using Ionic 7 and React for the frontend, and Laravel 10 for the backend. The communication between the frontend and backend is handled through a REST API, documented with the OpenAPI standard.

Capabilities

The prototype has the capability to register users, verify them, manage groups, and handle tasks to earn points and rewards to spend. It also includes options to adjust the logic for creating and completing tasks and rewards, depending on the level of trust between the couple.

Technologies Used

  • Frontend: Ionic 7, React

  • Backend: Laravel 10

  • API Documentation: OpenAPI Standard

Getting Started

Prerequisites

  • Node.js
  • PHP 8+
  • Composer
  • Ionic CLI

Installation

  1. Clone the repository:

    • Clone main project and all modules:
      git clone --recurse-submodules https://github.com/RK181/FamilyPoints-TFG-2023-24.git
      
    • Clone main project and modules, one by one:
      git clone https://github.com/RK181/FamilyPoints-TFG-2023-24.git
      cd FamilyPoints-ionic-front
      git submodule init
      git submodule update
      cd ../FamilyPoints-laravel-api
      git submodule init
      git submodule update
      
    • Pull main project and submodules:
      git pull --recurse-submodules
      
  2. Prepare frontend:

    cd FamilyPoints-ionic-front
    npm install
    
  3. Prepare backend:

    cd FamilyPoints-laravel-api
    cp .env.example .env
    php artisan key:generate
    php artisan migrate:refresh
    
  4. Run the development servers:

    • Frontend:
      cd FamilyPoints-ionic-front
      ionic serve
      
    • Backend:
      cd FamilyPoints-laravel-api
      php artisan serve
      

familypoints-tfg-2023-24's People

Contributors

rk181 avatar

Stargazers

 avatar

Watchers

 avatar

familypoints-tfg-2023-24's Issues

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.