JCSnap / SoulScribe2

Open source version of SoulScribe. In the midst of major refactoring + shifting from javascript to typescript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SoulScribe

SoulScribe is a gamified AI-powered journaling app done under the National University of Singapore (NUS)'s Orbital program. Think Spotify Recap, but instead of recapping your music journey, this app aims to recap your life journey based on your journal entries. This is made possible by leveraging on text-to-text and text-to-image generative AI.

Main Feature

Create Weekly Recap

At the end of every week, the system would automatically generate the summary of your week and create an art based on the highlight of your week. Look at the documentation for a sense of how it looks like.

Query Your Past

Ask questions about your past. Think chatGPT but with access to all your journal entries.

Gamification

Earn coins by journaling and doing it consistently. Coins can then be used to buy collectibles (to customize home page), or art styles (to generate your recaps).

File Structure

  • src
    • assets (static assets like images and fonts)
    • backend (databases, API queries etc.)
    • components (reusable UIs)
    • constants (self-explanatory)
    • screens (basically like React's pages)
    • utils (helper functions, helkper classes, modules)
  • tests (self-explanatory)

Download

The app is currently available on:

Documentation

Details on our thought process when creating the app:

For documentations on how to contribute, look into the /doc folder.

About

Open source version of SoulScribe. In the midst of major refactoring + shifting from javascript to typescript


Languages

Language:JavaScript 85.7%Language:Python 14.0%Language:TypeScript 0.3%