https://github.com/yll0rd/ai-mood
https://github.com/yll0rd/ai-mood
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yll0rd/ai-mood
- Owner: yll0rd
- Created: 2024-10-16T20:00:02.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-21T12:41:56.000Z (over 1 year ago)
- Last Synced: 2025-04-14T14:57:17.549Z (about 1 year ago)
- Language: TypeScript
- Size: 419 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
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.
💻 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:
- [NodeJS](https://nodejs.org/)
- [NextJS](https://github.com)
- [Prisma](https://www.prisma.io/orm)
- [Langchain](https://js.langchain.com/docs/)
- [NeonDB Account](https://neon.tech)
- [Google Gen AI Api Key](https://aistudio.google.com/)
Environment Setup
-
Copy the `.env.example` to `.env` and fill in the required environment variables:
```bash
cp .env.example .env
```
-
If you have any environment variables specific to your local environment, copy .env.local.example to .env.local and set them up as well:
```bash
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
```bash
git clone https://github.com/yll0rd/ai-mood.git
```
Installation
```bash
cd ai-mood
npm install
```
Prisma Setup
Once the repository is cloned, you need to generate Prisma Client and apply migrations:
-
Push the Prisma schema to your NeonDB:
```bash
npx prisma db push
```
-
Generate the Prisma client:
```bash
npx prisma generate
```
Starting
How to start your project
```bash
npm run dev
```
⚙️ Running Tests
To run tests, run the following command
```bash
npm run test
```
🤝 Collaborators
Special thank you for all people that contributed for this project.
📫 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.](https://clerk.com/docs/quickstarts/nextjs)
[📝 How to connect a Next.js application to Neon](https://neon.tech/docs/guides/nextjs)
