Giter Club home page Giter Club logo

tinypet's Introduction

Tinypet

Projet Cloud ALMA 2023/2024

This guide outlines the necessary steps to run and deploy the application. Please ensure all instructions are followed for the application to function properly.

MainPage

Architecture

The application is composed of two main parts: - The backend, which is a Java application using the JEE Servlet API, and is deployed on Google App Engine. - The frontend, which is an Angular application, and is deployed on the same App Engine instance as the backend.

Kinds in Datastore

kinds

API Endpoints

endpoints

Indexes in Datastore

indexes

Known Issues

  • When refreshing the page, the application will return a 404 not found error. This is due to the application being a single page application, and the server not being configured to handle this. The routes will still work as expected.

  • Sometimes, requests to datastore are slow (about 2 to 4 seconds). Thiis is due to the basic instance class of the datastore. This can be fixed by upgrading the instance class, but this will incur additional costs. But caching can also be used to reduce the number of requests to datastore.

  • The application is not responsive, and is not optimized for mobile devices.

  • The application is not tested on all browsers, and may not work as expected on Safari or old browsers. Https automatic redirection is not supported.

  • The login is triggered automatically when refreshing the main page.

Use prerequisites

  • Java 11 installed (Due to Google ending support for Java 8).

  • Google Cloud SDK (gcloud) installed, authenticated, and configured with your project.

  • Necessary APIs enabled in the Google Cloud Console (Google +, Endpoints, Datastore API…​).

  • Relevant gcloud services and components installed on your local machine.

Personnal Configuration Steps

  1. Changing the Project ID in pom.xml:

    • Update the <projectID> in pom.xml to your Google Cloud Project ID.

  2. Installing Required Npm Dependencies:

    • run npm i inside the tinypey-app folder to install all required dependencies for the building.

    • For maven dependencies, no need as the commands bellow do the work.

Running / Deploying the application

  1. Locally:

    • For Windows, use run.bat.

    • For Unix-based systems, use run.sh. (chmod +x run.sh before first execution)

  2. To App Engine Cloud Console:

    • For Windows, use deploy.bat.

    • For Unix-based systems, use deploy.sh (chmod +x deploy.sh before first execution)

Important Notes

  • Ensure Java 11 is used, as the project is not compatible with Java 8.

tinypet's People

Contributors

yassineder avatar

Watchers

 avatar

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.