Skip to content

Latest commit

 

History

History
147 lines (103 loc) · 3.05 KB

README.md

File metadata and controls

147 lines (103 loc) · 3.05 KB
Raw

AI-MOOD 💻

Technologies Getting Started Collaborators Contribute

An NLP-powered app that analyzes and tracks users' moods based on their journal entries through text recognition.

📱 Visit this Project

💻 Technologies

  • NextJS
  • Prisma
  • ClerkJS
  • LangChain
  • Google Gen AI
  • NeonDB

🚀 Getting started

How to run the project locally

Prerequisites

Here you list all prerequisites necessary for running your project. For example:

Environment Setup

  1. Copy the `.env.example` to `.env` and fill in the required environment variables: 
    cp .env.example .env
  2. If you have any environment variables specific to your local environment, copy .env.local.example to .env.local and set them up as well: 
    cp .env.local.example .env.local

    Make sure to add your GOOGLE_GEN_AI_API_KEY, DATABASE_URL (from NeonDB), and any other required environment variables in the .env or .env.local files.

Cloning

How to clone your project

git clone https://github.com/yll0rd/ai-mood.git

Installation

cd ai-mood
npm install

Prisma Setup

Once the repository is cloned, you need to generate Prisma Client and apply migrations:

  1. Push the Prisma schema to your NeonDB: 
    npx prisma db push
  2. Generate the Prisma client: 
    npx prisma generate

Starting

How to start your project

npm run dev

⚙️ Running Tests

To run tests, run the following command

  npm run test

🤝 Collaborators

Special thank you for all people that contributed for this project.

Youmbi leo Profile Picture
Youmbi Leo

📫 Contribute

Contributions are always welcome!

  1. git clone https://github.com/yll0rd/ai-mood.git
  2. git checkout -b feature/NAME
  3. Follow commit patterns
  4. Open a Pull Request explaining the problem solved or feature made, if exists, append screenshot of visual modifications and wait for the review!

Documentations that might help

📝 How to set up Clerk with environment variables, including integrating it with React and Next.js.

📝 How to connect a Next.js application to Neon