Skip to content

jsl1114/Lobster-AI

Repository files navigation

Lobster AI

Vercel deployment now out at lobster-ai.vercel.app

To access CIMS deployment, click here

Overview

Recall how you have to wander around the internet on different platforms to find different AI services such as music and video generation...

Lobster AI is a paid AI service that combines major AI platforms and further enhances your interactions with AI. Let the Lobster be in the palm of your hand! Start to have conversations, generate image, music, videos, code with the powerful Lobster!

Developer's Notes (Apply to NYU CIMS deployment only)

  1. When NEXT_PUBLIC_NODE_ENV=production, the app will adapt to the cims linserv1 server, meaning that it will
    1. remove unsupported music generation and video generation features (api does not work due to node version cap)
    2. set chatgpt api model to only use 3.5 turbo (same reason above)
    3. use next13 (slower compile and larger build files, same reason)
  2. NEXT_PUBLIC_NODE_ENV=development, full features as advertised, all working
  3. stripe and landing page still under development
  4. The vercel deployment has all features working, see link at top of page

Data Model

The application will store Users, Subscription and History

  • each user is linked to a subscription of three tiers: free, standard and pro (via references)
  • each user has a history, which records that user's former requests within the app (viewable upon updrading to standard or pro tier)

An Example User:

{
  id: 'h1i2uhupuohr10' // use for reference
  username: "shannonshopper",
  hash: // a password hash,
}

An Example Subscription

{
  user: // a reference to a User object
  tier: "free", // the tier which the user is in
  createdAt: // timestamp
}

An Example History

{
  user: // a reference to a User object
  history: [ // arr of former reqs made 
    {
      prompt: 'how to embed a youtube link in html?'
      createdAt: // timestamp
    },
    {
      prompt: 'list of best ramen shops in NYC',
      createdAt: // timestamp
    },
    ...
  ]
}

note: this app uses prisma ORM, schemas are stored within /prisma/schema.prisma

Wireframes

/ - landing page

landing

/dashboard - dashboard page for an overview of all services

dashboard

/conversation - page for conversation with lobster

conversation

/image - page for image generation

image

/video - page for video generation

video

/code - page for code generation

code

/music - page for music generation

music

---
title: Sitemap (Client Side)
---
flowchart TB
  A["/landing"] --> K{Signed in?}
  K -- yes ---> D
  K-- no ---> C["/sign-up"]
  K-- no ---> B
  C -- After signing up ---> D
  B["/sign-in"] -- After succesful sign in ---> D["/dashboard"]
  D -- log out ---> A
  D --> E["/conversation"]
  D --> F["/image"]
  D --> G["/video"]
  D --> H["/music"]
  D --> I["/code"]
  D -- if trial used up --> J["/upgrade"]
Loading

User Stories or Use Cases

  1. as non-registered user, I can register a new account with the site
  2. as a new user defaulted to free tier, I can log in to the site and pay for upgrades
  3. as a free tier user, I can send a total of 10 requests to the api as free trial. After that, I will be instructed to pay for an upgrade in order to continue using the app
  4. as a standard tier user, I pay 39.99 dollars a month and have access to all the generation tools, with limit on certain features
  5. as a pro tier user, I pay 49.99 dollars a month and have access to all of the features on the website with the newest models, plus access to user history, which shows the past quries and responses, up tp 90 days

Research Topics

Points Topic Notes
5 Automated Functional Testing using Cypress
6 Frontend Framework Next.js
5 User Authentication clerk
2 CSS framework tailwind.css
2 Sitemap Mermaid
1 OpenAI chat generation API
(with finetuning.)
link
1 OpenAI DALL·E API
(with finetuning.)
link
1 Replicate AI music generation link

More to be added. Total of 23 / 8 points

Annotations / References Used

Topic Reference
Automated Functional Testing Cypress
Frontend Framework Next.js
User Authentication clerk
CSS framework tailwind.css
OpenAI chat generation API
(with finetuning.)
link
OpenAI DALL·E API
(with finetuning.)
link
Replicate AI music generation link

About

AI SaaS platform that combines the magic of the latest Generative Pre-trained Transformers

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors