GOSAI-DVIC/gosai

Bootstrap your augmented reality applications and transform any platform into an augmented reality interface

8

stars

107

commits

JavaScript

primary language

Sep 14, 2024

updated

augmented-reality
docker
framework
javascript
python

README

General-purpose Operating System for Augmented Interfaces

Base repository of the GOSAI project. This is an open-source and collaborative project to create augmented reality plateforms.

placeholder

Requirements

Docker is required to use this project

Edit the .env file to to set your dockerhub username, the repository you want to push it to, the name of the platform you are using and optional device and version to keep track of changes.

Quickstart

ActionCommand
Build the imagemake build
Launch (with docker)make launch
Stopmake stop
Push on Dockermake push
Pull from Dockermake pull

Deployement

The following method uses systemctl to ready GOSAI for demos.

Create a service in /home/{USER}/.config/systemd/user/ called gosai.service. This service needs to use make launch in the project repository. See the example ./build/gosai.service.

Install an exisisting project

To install an existing project, simply clone the project in a directory called home. For example, use git clone https://github.com/GOSAI-DVIC/second-self.git home inside the gosai repository project to install the second-self project.

Create your own project

Refer to this tutorial to learn how to develop on gosai.

Developping

Boot in a virtual environment :

python3 -m venv .venv pip3 install -r build/cpu/requirements.txt source .venv/bin/activate && make boot

Contributors

maxbroubrou

45 commits

Thomas-Jld

23 commits

nathanvid

19 commits

AdrLfv

15 commits

GOSAI-DVIC/gosai

Bootstrap your augmented reality applications and transform any platform into an augmented reality interface

8

stars

107

commits

JavaScript

primary language

Sep 14, 2024

updated

augmented-reality
docker
framework
javascript
python

README

General-purpose Operating System for Augmented Interfaces

Base repository of the GOSAI project. This is an open-source and collaborative project to create augmented reality plateforms.

placeholder

Requirements

Docker is required to use this project

Edit the .env file to to set your dockerhub username, the repository you want to push it to, the name of the platform you are using and optional device and version to keep track of changes.

Quickstart

ActionCommand
Build the imagemake build
Launch (with docker)make launch
Stopmake stop
Push on Dockermake push
Pull from Dockermake pull

Deployement

The following method uses systemctl to ready GOSAI for demos.

Create a service in /home/{USER}/.config/systemd/user/ called gosai.service. This service needs to use make launch in the project repository. See the example ./build/gosai.service.

Install an exisisting project

To install an existing project, simply clone the project in a directory called home. For example, use git clone https://github.com/GOSAI-DVIC/second-self.git home inside the gosai repository project to install the second-self project.

Create your own project

Refer to this tutorial to learn how to develop on gosai.

Developping

Boot in a virtual environment :

python3 -m venv .venv pip3 install -r build/cpu/requirements.txt source .venv/bin/activate && make boot

Contributors

maxbroubrou

45 commits

Thomas-Jld

23 commits

nathanvid

19 commits

AdrLfv

15 commits

Languages

JavaScript

96.6%

Python

3.1%