Skip to content

GETSTARTED.md

Latest commit

 

History

History
140 lines (91 loc) · 3.58 KB

GETSTARTED.md

File metadata and controls

140 lines (91 loc) · 3.58 KB
Raw

Getting Started with Aula

This document provides an overview of the Aula application, including setup instructions and information about the development environment.

Run aula frontend using Docker

Local testing

Assuming you installed Docker, you can test the frontend with the default .env.docker which points to devel.aula.de backend with the following:

docker run --env-file .env.docker -p 3000:80 aulaapp/aula-frontend:latest

You can copy and edit the .env.docker to change the configuration.

Production self-hosting setup

For production setup, configure your own envfile and make sure that you configure SSL either by adapting aula-frontend image, or by putting a reverse proxy with SSL in front of it.

Reach out to dev [at] aula.de for more information.

Getting Started

Prerequisites

  • Node.js (version 18 or higher recommended; we test and deploy on version found in .nvmrc)
  • Yarn (we use yarn, you could theoretically use npm)
  • Docker (if you want to build/publish/deploy using Docker)

Installation

  1. Clone the repository:

    git clone https://github.com/aula-app/aula-frontend.git

  2. Navigate to the project directory:

    cd aula-frontend

  3. Install dependencies:

    yarn

Database Setup and Configuration

  1. Set up Aula's API Back End based on the Aula's Backend Repository.

Environment Configuration

  1. Create a .env file based on the .env.local file: (TODO: out of date)

    cp .env.local .env

  2. Update the values in the .env file with your configuration:

    VITE_APP_VERSION = $npm_package_version
VITE_APP_CENTRAL_API_URL = http://localhost:8080
VITE_APP_MULTI = false

  3. Start the development server:

    yarn dev

    The application will start in development mode. Open your browser to the URL shown in the terminal to view the app.

Mobile Development

The application includes Capacitor integration for building mobile apps. To start Android development:

# Make sure to have local tooling for Android/iOS development installed
#   eg. export CAPACITOR_ANDROID_STUDIO_PATH=/opt/android-studio/bin/studio
yarn build-app && npx cap sync && \
   npx cap open android

Development on the local network

Access your local backend server and frontend dev server from a mobile device on your local network.

This workflow assumes that

  • the backend server is reachable under IP 192.…
  • backend listens on 0.0.0.0:8080 (which should be the case with the Docker setup, but ymmv)
  • your Tenant has UUID 12ab… (see `php artisan tenant:list)

The Backend + On device steps are necessary to properly set api_url in localStorage.

Frontend

  • edit .env, set VITE_APP_API_URL=http://192.…:8080
  • and maybe (TODO)
    APP_FRONTEND_URL = http://192.…:3000
    APP_FRONTEND_HOST = http://192.…
  • run frontend with yarn --host (or specify IP explicitly)

Backend

set Tenant's api_base_url:

php artisan tinker
$t = App\Models\Tenant::find('12ab…');
$t->api_base_url = 'http://192.…:8080';
$t->save();

Check with php artisan tenant:list.

On the device

  • log out
  • "forget"/reset instance code
  • log in

Deployment

Please reach out to dev [at] aula.de for instructions on self-hosting in production environment.

Build and publish using Docker

To build and publish your local version of the repo:

docker build -t YOUR_ORG/aula-frontend:latest
docker push YOUR_ORG/aula-frontend:latest