EdCore

MobSF

EdCore: Augmented Reality (AR) History Education App

EdCore is an innovative Augmented Reality (AR) history education microservice app that leverages the power of Artificial Intelligence (AI) and Machine Learning (ML) to provide an immersive and personalized learning experience. This README file serves as a comprehensive guide to help you understand, set up, and contribute to the EdCore project.

EdCore by KOSASIH is licensed under Attribution 4.0 International

Table of Contents

Introduction

EdCore redefines history education by blending cutting-edge Augmented Reality technology with AI-driven personalization. This microservice app allows users to explore historical events, figures, and places in a truly immersive manner, enhancing engagement and comprehension. Through gamified challenges, collaborative learning, and dynamic content, EdCore transforms history education into an interactive adventure.

Features

Vision And Mission

Vision: Empower learners to transcend time through immersive augmented reality, fostering a deeper understanding of history and promoting a global culture of curiosity and education.

Mission: Our mission is to revolutionize history education by harnessing the potential of augmented reality (AR), artificial intelligence (AI), and machine learning (ML). We are committed to providing a transformative learning experience that:

At EdCore, we are driven by our vision to enable learners to transcend time, fostering a world where history is not just studied, but experienced, understood, and cherished. Our mission is to pave the way for a future where history education is no longer confined to textbooks and lectures, but a living, breathing exploration that captivates minds and ignites imaginations.

Technologies We Use

EdCore leverages a powerful blend of cutting-edge technologies to deliver its immersive Augmented Reality (AR) history education experience, personalized learning, and collaborative features. Our technology stack is carefully selected to create a seamless and engaging user experience while ensuring scalability, performance, and security. Some of the key technologies we use include:

  1. Augmented Reality (AR) Frameworks:
    • AR.js: Bringing AR experiences to the web using JavaScript and web standards.
    • A-Frame: A web framework for building virtual reality (VR) experiences with HTML and JavaScript.
    • WebXR: Enabling AR and VR experiences directly in web browsers.
  2. Artificial Intelligence (AI) and Machine Learning (ML):
    • TensorFlow: An open-source machine learning framework for building AI models.
    • scikit-learn: A versatile ML library for classification, regression, clustering, and more.
    • Natural Language Processing (NLP) libraries: NLTK, SpaCy, or similar for text analysis.
  3. Backend and API Development:
    • Node.js: A runtime environment for building scalable and efficient server-side applications.
    • Express.js: A web application framework for Node.js that simplifies routing and middleware.
  4. Frontend Development:
    • Angular or React: Modern frontend frameworks for building interactive user interfaces.
    • Webpack: A module bundler for managing frontend assets and dependencies.
  5. Database and Data Storage:
    • MongoDB: A NoSQL database for storing dynamic and flexible data structures.
    • MySQL or PostgreSQL: Relational databases for structured data storage.
  6. Cloud Services and Deployment:
    • Docker: Containerization for consistent and isolated app deployment.
    • Kubernetes or OpenShift: Container orchestration for managing app deployment at scale.
    • IBM Cloud Pak or similar: For deploying and managing cloud-native applications.
  7. Version Control and Collaboration:
    • Git: Distributed version control system for tracking code changes and collaborating.
    • GitHub: Hosting platform for version control, code review, and collaboration.
  8. Authentication and Security:
    • OAuth or JWT: Secure user authentication and authorization.
    • HTTPS: Secure communication between clients and servers.
  9. Testing and Quality Assurance:
    • Jest or Mocha: JavaScript testing frameworks for unit and integration tests.
    • Continuous Integration (CI) tools: Jenkins, Travis CI, or GitHub Actions for automated testing.
  10. Analytics and Monitoring:
    • Prometheus and Grafana: Monitoring and alerting for app performance and health.
  11. Project Management and Documentation:
    • Agile methodologies: Scrum or Kanban for project management.
    • Documentation: Markdown, Swagger, or similar for API documentation.

EdCore’s technology stack is carefully chosen to deliver a seamless and innovative history education experience. By integrating these technologies, we create an app that not only educates but also inspires learners to engage with history in entirely new ways.

Our Roadmap

EdCore Roadmap

At EdCore, we are committed to continuous innovation and improvement. Our roadmap outlines the exciting milestones and features we have planned for the future, as we strive to enhance the Augmented Reality (AR) history education experience and expand the reach of our platform. Here’s what you can expect from EdCore in the coming months and years:

Quarter 1 - Enhancing Immersion (Current Quarter)

Quarter 2 - Personalization and Gamification

Quarter 3 - Global Accessibility and Collaboration

Quarter 4 - Expanding Historical Content

Year 2 - Empowering Educators

Year 3 - Continuous Learning and Beyond

Year 4 - Empowering Underserved Communities

Year 5 - Cultural Integration and Impact Measurement

Year 6 - Advanced Analytics and Partnerships

Year 7 - AI-Driven Historical Insights

Year 8 - Lifelong Learning Ecosystem

Year 9 - Global Cultural Heritage Preservation

Year 10 - Futuristic Vision: AR Time Travel

Year 11 - Ethical and Inclusive AR Education

Year 12 - AR Time Capsules and Historical Recreations

Year 13 - AI-Powered Language Translation and Subtitles

Year 14 - Environmental and Sustainability Education

Year 15 - Interdimensional History Exploration

Year 16 - AI-Powered Conversations with Historical Figures

Year 17 - Intergenerational Learning and Storytelling

Year 18 - Beyond Earth: Cosmic History Exploration

Year 19 - AI-Enhanced Creative Expression

Year 20 - Quantum Historical Exploration

Year 21 - Emotionally Intelligent Historical Narratives

Year 22 - Interactive Historical Reenactments

Year 23 - Quantum Collaboration with Historians

Year 24 - AR-Integrated Time Capsule Vaults

Year 25 - Mind-Melding with History

Year 26 - Deep Learning for Historical Interpretation

Year 27 - Dreamworlds of History

Year 28 - Synesthetic Historical Experiences

Year 29 - Parallel Reality Time-Travel

Year 30 - The Timeless Nexus: Past, Present, Future

Year 31 - Quantum Interactions with Historical Figures

Year 32 - Cosmic Time Travel Exploration

Year 33 - Ethereal History Unveiled

Year 34 - Infinite Perspectives Time Loop

Year 35 - Thought-Encoded Historical Memory

Year 36 - Quantum Historical Ethics

Year 37 - AI-Historical Fusion Artistry

Year 38 - Transcendent Learning Nexus

Year 39 - Quantum Historiographical Symposium

Year 40 - Beyond Temporal Bounds

Year 41 - The Essence of Sentient History

Year 42 - Multiversal Historiography

Year 43 - Quantum Archeology Expeditions

Year 44 - Harmonic Resonance with History

Year 45 - Quantum Poetry of History

Year 46 - Quantum Narratives Through Dreams

Year 47 - Holographic Chronoportation

Year 48 - Quantum Museums of History

Year 49 - Ascendant Historiography

Year 50 - The Eternal Odyssey

Year 51 - Chrono-Spatial Holography

Year 52 - Quantum Ethics Simulations

Year 53 - Cosmic-Historical Symphonies

Year 54 - Quantum Nomad Expeditions

Year 55 - Historical Symbiosis

Year 56 - Quantum Historical Mirrors

Year 57 - Time-Flow Literary Fusions

Year 58 - Quantum Memory Resonance

Year 59 - Transdimensional Historical Poetry

Year 60 - The Infinite Historiographical Nexus

Year 61 - Temporal Harmonics Symphony

Year 62 - Quantum Ethnography Expeditions

Year 63 - Quantum Language Translation

Year 64 - Historical Haikus Across Timelines

Year 65 - Quantum Kinetic Sculptures

Year 66 - Quantum Philosophical Debates

Year 67 - Historical Quantum Gardens

Year 68 - Quantum Cuisine Expeditions

Year 69 - Quantum Dance of History

Year 70 - The Infinite Nexus Continuum

Year 71 - Quantum Embrace of Nature

Year 72 - Quantum Art Restoration

Year 73 - Quantum Socratic Dialogues

Year 74 - Historical Quantum Gastronomy

Year 75 - Quantum Dreamworld Chronicles

Year 76 - Quantum Artistic Fusion

Year 77 - Temporal Memory Puzzles

Year 78 - Quantum Ethereal Music

Year 79 - Quantum Architectural Reveries

Year 80 - The Eternal Nexus Symphony

Year 81 - Quantum Kinetic Literature

Year 82 - Quantum Ethical Paradoxes

Year 83 - Quantum Mythopoeia

Year 84 - Quantum Exoplanetary Histories

Year 85 - Quantum Dance of Language

Year 86 - Quantum Temporal Illusions

Year 87 - Quantum Museums of Thought

Year 88 - Quantum Time-Woven Tapestries

Year 89 - Quantum Ecological Interplay

Year 90 - The Infinite Nexus Reverie

Year 91 - Quantum Meditative Reflections

Year 92 - Quantum Ethical Infinity

Year 93 - Quantum Interdimensional Artistry

Year 94 - Quantum Storytelling Spectacles

Year 95 - Quantum Memory Labyrinths

Year 96 - Quantum Dream Interpretations

Year 97 - Quantum Geographical Narratives

Year 98 - Quantum Sentient Art Installations

Year 99 - Quantum Temporal Reflections

Year 100 - The Celestial Nexus Unveiled

EdCore’s transformative hundred-year roadmap concludes with an extraordinary exploration of meditation, ethics, art, dreams, and the cosmos, culminating in a celestial nexus of knowledge and insight. As we traverse the realms of consciousness, symbolism, and interdimensional experiences, EdCore remains dedicated to nurturing wisdom, connection, and a profound appreciation for the intricate narratives that shape our reality.

Embark on the ultimate odyssey of historical enlightenment with EdCore, where every revelation is a glimpse into the infinite expanse of human experience and understanding.

Last updated: August 18, 2023

Getting Started

Prerequisites

Installation

  1. Clone the EdCore repository: 
    git clone https://github.com/KOSASIH/edcore.git
cd edcore
  2. Install the required dependencies: 
    npm install

  3. Set up your AR SDK and configure AI/ML libraries as needed.

  4. Launch the EdCore app: 
    npm start
  5. Access the app in your browser at http://localhost:3000.

Usage

  1. Explore AR History: Launch the app, select a historical event or place, and use your device’s camera to experience AR content.

  2. Personalized Learning: Engage with quizzes and challenges tailored to your learning style and progress.

  3. Collaborative Learning: Join virtual study groups to share insights and discuss historical topics.

  4. Gamified Challenges: Test your historical knowledge with interactive challenges and earn rewards.

Contributing

We welcome contributions from the community to enhance EdCore’s features and capabilities. To contribute, follow these steps:

  1. Fork the repository and create a new branch for your feature/fix.

  2. Make your changes, add tests if applicable, and ensure the code follows the project’s coding standards.

  3. Commit your changes and push the branch to your fork.

  4. Open a pull request, describing your changes and the problem they solve.

  5. Participate in the review process and make necessary adjustments.

License

EdCore is released under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.

Thank you for your interest in EdCore! We hope this README provides you with a comprehensive understanding of the app’s features, setup, and contribution guidelines. If you have any questions or need assistance, please reach out to our development team at devteam@edcoreapp.com. Happy learning!

Project Structure

Node is required for generation and recommended for development. package.json is always generated for a better development experience with prettier, commit hooks, scripts and so on.

In the project root, JHipster generates configuration files for tools like git, prettier, eslint, husky, and others that are well known and you can find references in the web.

/src/* structure follows default Java structure.

Development

Before you can build this project, you must install and configure the following dependencies on your machine:

  1. Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

npm install

We use npm scripts and Angular CLI with Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.

./gradlew -x webapp
npm start

Npm is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run npm update and npm install to manage dependencies. Add the help flag on any command to see how you can use it. For example, npm help update.

The npm run command will list all of the scripts available to run for this project.

PWA Support

JHipster ships with PWA (Progressive Web App) support, and it’s turned off by default. One of the main components of a PWA is a service worker.

The service worker initialization code is disabled by default. To enable it, uncomment the following code in src/main/webapp/app/app.module.ts:

ServiceWorkerModule.register('ngsw-worker.js', { enabled: false }),

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

npm install --save --save-exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

npm install --save-dev --save-exact @types/leaflet

Then you would import the JS and CSS files specified in library’s installation instructions so that Webpack knows about them: Edit src/main/webapp/app/app.module.ts file:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/scss/vendor.scss file:

@import 'leaflet/dist/leaflet.css';

Note: There are still a few other things remaining to do for Leaflet that we won’t detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Developing Microfrontend

Microservices doesn’t contain every required backend feature to allow microfrontends to run alone. You must start a pre-built gateway version or from source.

Start gateway from source:

cd gateway
npm run docker:db:up # start database if necessary
npm run docker:others:up # start service discovery and authentication service if necessary
npm run app:start # alias for ./(mvnw|gradlew)

Microfrontend’s build-watch script is configured to watch and compile microfrontend’s sources and synchronizes with gateway’s frontend. Start it using:

cd microfrontend
npm run docker:db:up # start database if necessary
npm run build-watch

It’s possible to run microfrontend’s frontend standalone using:

cd microfrontend
npm run docker:db:up # start database if necessary
npm watch # alias for `npm start` and `npm run backend:start` in parallel

Using Angular CLI

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate few files:

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

JHipster Control Center

JHipster Control Center can help you manage and control your application(s). You can start a local control center server (accessible on http://localhost:7419) with:

docker compose -f src/main/docker/jhipster-control-center.yml up

OAuth 2.0 / OpenID Connect

Congratulations! You’ve selected an excellent way to secure your JHipster application. If you’re not sure what OAuth and OpenID Connect (OIDC) are, please see What the Heck is OAuth?

To log in to your app, you’ll need to have Keycloak up and running. The JHipster Team has created a Docker container for you that has the default users and roles. Start Keycloak using the following command.

docker compose -f src/main/docker/keycloak.yml up

The security settings in src/main/resources/config/application.yml are configured for this image.

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            issuer-uri: http://localhost:9080/realms/jhipster
        registration:
          oidc:
            client-id: web_app
            client-secret: web_app
            scope: openid,profile,email

Some of Keycloak configuration is now done in build time and the other part before running the app, here is the list of all build and configuration options.

Before moving to production, please make sure to follow this guide for better security and performance.

Also, you should never use start-dev nor KC_DB=dev-file in production.

When using Kubernetes, importing should be done using init-containers (with a volume when using db=dev-file).

Okta

If you’d like to use Okta instead of Keycloak, it’s pretty quick using the Okta CLI. After you’ve installed it, run:

okta register

Then, in your JHipster app’s directory, run okta apps create and select JHipster. This will set up an Okta app for you, create ROLE_ADMIN and ROLE_USER groups, create a .okta.env file with your Okta settings, and configure a groups claim in your ID token.

Run source .okta.env and start your app with Maven or Gradle. You should be able to sign in with the credentials you registered with.

If you’re on Windows, you should install WSL so the source command will work.

If you’d like to configure things manually through the Okta developer console, see the instructions below.

First, you’ll need to create a free developer account at https://developer.okta.com/signup/. After doing so, you’ll get your own Okta domain, that has a name like https://dev-123456.okta.com.

Modify src/main/resources/config/application.yml to use your Okta settings.

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            issuer-uri: https://{yourOktaDomain}/oauth2/default
        registration:
          oidc:
            client-id: {clientId}
            client-secret: {clientSecret}
security:

Create an OIDC App in Okta to get a {clientId} and {clientSecret}. To do this, log in to your Okta Developer account and navigate to Applications > Add Application. Click Web and click the Next button. Give the app a name you’ll remember, specify http://localhost:8080 as a Base URI, and http://localhost:8080/login/oauth2/code/oidc as a Login Redirect URI. Click Done, then Edit and add http://localhost:8080 as a Logout redirect URI. Copy and paste the client ID and secret into your application.yml file.

Create a ROLE_ADMIN and ROLE_USER group and add users into them. Modify e2e tests to use this account when running integration tests. You’ll need to change credentials in src/test/javascript/e2e/account/account.spec.ts and src/test/javascript/e2e/admin/administration.spec.ts.

Navigate to API > Authorization Servers, click the Authorization Servers tab and edit the default one. Click the Claims tab and Add Claim. Name it “groups”, and include it in the ID Token. Set the value type to “Groups” and set the filter to be a Regex of .*.

After making these changes, you should be good to go! If you have any issues, please post them to Stack Overflow. Make sure to tag your question with “jhipster” and “okta”.

Auth0

If you’d like to use Auth0 instead of Keycloak, follow the configuration steps below:

function (user, context, callback) {
  user.preferred_username = user.email;
  const roles = (context.authorization || {}).roles;

  function prepareCustomClaimKey(claim) {
    return `https://www.jhipster.tech/${claim}`;
  }

  const rolesClaim = prepareCustomClaimKey('roles');

  if (context.idToken) {
    context.idToken[rolesClaim] = roles;
  }

  if (context.accessToken) {
    context.accessToken[rolesClaim] = roles;
  }

  callback(null, user, context);
}

spring:
  ...
  security:
    oauth2:
      client:
        provider:
          oidc:
            # make sure to include the ending slash!
            issuer-uri: https://{your-auth0-domain}/
        registration:
          oidc:
            client-id: {clientId}
            client-secret: {clientSecret}
            scope: openid,profile,email
jhipster:
  ...
  security:
    oauth2:
      audience:
        - https://{your-auth0-domain}/api/v2/

Doing API-First development using openapi-generator-cli

OpenAPI-Generator is configured for this application. You can generate API code from the src/main/resources/swagger/api.yml definition file by running:

./gradlew openApiGenerate

Then implements the generated delegate classes with @Service classes.

To edit the api.yml definition file, you can use a tool such as Swagger-Editor. Start a local instance of the swagger-editor using docker by running: docker compose -f src/main/docker/swagger-editor.yml up -d. The editor will then be reachable at http://localhost:7742.

Refer to Doing API-First development for more details.

Building for production

Packaging as jar

To build the final jar and optimize the EdCore application for production, run:

./gradlew -Pprod clean bootJar

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:

java -jar build/libs/*.jar

Then navigate to http://localhost:8081 in your browser.

Refer to Using JHipster in production for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:

./gradlew -Pprod -Pwar clean bootWar

Testing

To launch your application’s tests, run:

./gradlew test integrationTest jacocoTestReport

Client tests

Unit tests are run by Jest. They’re located in src/test/javascript/ and can be run with:

npm test

Other tests

Performance tests are run by Gatling and written in Scala. They’re located in src/test/java/gatling/simulations.

You can execute all Gatling tests with

./gradlew gatlingRun.

For more information, refer to the Running tests page.

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker compose -f src/main/docker/sonar.yml up -d

Note: we have turned off forced authentication redirect for UI in src/main/docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.

You can run a Sonar analysis with using the sonar-scanner or by using the gradle plugin.

Then, run a Sonar analysis:

./gradlew -Pprod clean check jacocoTestReport sonarqube -Dsonar.login=admin -Dsonar.password=admin

Additionally, Instead of passing sonar.password and sonar.login as CLI arguments, these parameters can be configured from sonar-project.properties as shown below:

sonar.login=admin
sonar.password=admin

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a oracle database in a docker container, run:

docker compose -f src/main/docker/oracle.yml up -d

To stop it and remove the container, run:

docker compose -f src/main/docker/oracle.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

npm run java:docker

Or build a arm64 docker image when using an arm64 processor os like MacOS with M1 processor family running:

npm run java:docker:arm64

Then run:

docker compose -f src/main/docker/app.yml up -d

When running Docker Desktop on MacOS Big Sur or later, consider enabling experimental Use the new Virtualization framework for better processing performance (disk access performance is worse).

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

This site is open source. Improve this page.