https://github.com/luke100000/immersivelibrary

A generic user asset library
https://github.com/luke100000/immersivelibrary

Last synced: about 1 month ago
JSON representation

A generic user asset library

• Host: GitHub
• URL: https://github.com/luke100000/immersivelibrary
• Owner: Luke100000
• Created: 2023-03-31T07:10:57.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-05-29T13:13:59.000Z (6 months ago)
• Last Synced: 2024-05-30T03:13:23.005Z (6 months ago)
• Language: Python
• Size: 292 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Immersive Library

A generic user asset library, accessible via REST API, authenticated via Google Auth.

## Features

* Read access by anyone

* Authentication via Google Sign-In

* Tags

* Likes

* Moderator status

* Banning and optionally purging users

## How to use

### Server

The server is implemented in python using FastAPI. Launch using e.g. uvicorn:

```sh

cd python

uvicorn --reload main:app

```

### Client

For most methods a user-chosen access token is required. To acquire, call Google Sign-In and forward the response to

```

/v1/auth?token=YOUR_TOKEN

```

A Java example is included in the repo. The token should be securely random and sufficient in size.

## API

Access the documentation in your browser at `/redoc` or `/docs`.