Skip to content

Hsinha11/AI-Journal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌟 AI Journal - Your Digital Thought Sanctuary

AI Journal Banner

Made with Love React Vite Tailwind License

✨ Features

  • 🤖 AI-Enhanced Journaling - Your personal AI companion for deeper self-reflection.
  • 📝 Rich Text Editor - Express yourself with a beautiful, intuitive interface.
  • 🔒 Secure & Private - Your thoughts are encrypted and protected.
  • 🌙 Dark/Light Mode - Journal comfortably any time of day.
  • 📱 Responsive Design - Perfect on any device.
  • 🔄 Real-time Sync - Never lose a thought again.

🚀 Getting Started

Prerequisites

Installation & Setup

  1. Clone the repository:

    git clone https://github.com/Hsinha11/AI-Journal.git
    cd AI-Journal
  2. Install server dependencies:

    cd server
    npm install
  3. Install client dependencies:

    cd ../client
    npm install
  4. Set up environment variables:

    • Create a .env file in the server directory.
    • Add the following variables:
      PORT=8000
      MONGO_URI=your_mongodb_connection_string
      PINECONE_API_KEY=your_pinecone_api_key
      JWT_SECRET=a-very-long-and-secure-random-string-for-dev
      

Running the Application

  1. Start the backend server:

    cd server
    npm start
  2. Start the frontend development server:

    cd ../client
    npm run dev

The application will be available at http://localhost:5173.

🎭 Tech Stack

Frontend

  • React - For beautiful UI composition
  • Vite - Lightning-fast development
  • Tailwind CSS - Stylish and responsive design

Backend

  • Node.js - Server-side excellence
  • Express - RESTful API orchestration
  • MongoDB - Data persistence perfection
  • JWT - Secure authentication

AI & Machine Learning

  • Pinecone - Vector database for semantic search
  • @xenova/transformers - For generating text embeddings

🌿 Project Structure

ai-journal-app/
├── client/              # Frontend sanctuary
│   ├── src/
│   │   ├── components/  # UI building blocks
│   │   ├── context/
│   │   ├── lib/
│   │   └── pages/
│   └── public/
└── server/             # Backend fortress
    ├── models/         # Data blueprints
    ├── src/
    │   └── services/
    └── server.js

🤝 Contributing

Your creative energy is welcome here! Feel free to:

  1. 🍴 Fork the repository
  2. 🌟 Create your feature branch
  3. 💫 Commit your changes
  4. 🚀 Push to the branch
  5. 🎉 Open a Pull Request

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

💖 Acknowledgments

  • Hat tip to all contributors
  • Special thanks to the open-source community
  • Inspired by the power of AI and human creativity

Made with ❤️ by Harianant Sinha

Follow on GitHub


About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •