Skip to content

Tucuxi-Inc/FreeEuni

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Euni - US Law School Study Assistant

License: MIT iOS Swift OpenAI

Euni is an open-source iOS application that serves as an AI-powered study companion for US law school students. Built with SwiftUI and powered by OpenAI's Assistant API, Euni helps students master legal concepts, practice for exams, and track their study progress.

✨ Features

πŸŽ“ AI-Powered Study Assistant

  • Intelligent Tutoring: Chat with an AI assistant trained on legal concepts
  • Socratic Method: Guided questioning to develop critical thinking
  • Comprehensive Analysis: IRAC+ methodology for legal reasoning

πŸ“ Practice & Assessment

  • Multiple Choice Tests: AI-generated practice questions with detailed explanations
  • Flashcards: Targeted review materials for key legal concepts
  • Subject Coverage: Constitutional Law, Contracts, Torts, Criminal Law, Civil Procedure, Property, Evidence, and more

πŸ“Š Progress Tracking

  • Study Analytics: Track your performance across subjects
  • Achievement System: Unlock milestones and maintain study streaks
  • Leaderboards: Compare progress with other students (optional)

πŸ”§ Customizable Content

  • Your Own Assistant: Configure with your own OpenAI Assistant
  • Upload Study Materials: Add your law school outlines, cases, and notes
  • Personalized Learning: Assistant learns from your uploaded content

πŸš€ Quick Start

Prerequisites

  • iOS 18.0+ device or simulator
  • Xcode 14.0+
  • OpenAI API account
  • Apple Developer Account (for device testing)

Installation

  1. Clone the repository

    git clone https://github.com/Tucuxi-Inc/FreeEuni.git
    cd FreeEuni
  2. Set up your OpenAI Assistant

    πŸ“– Follow the detailed guide: OPENAI_ASSISTANT_SETUP.md

  3. Configure the app

    cp Euni/Config.swift.example Euni/Config.swift
    # Edit Config.swift with your API key and Assistant ID
  4. Open and run

    open Euni.xcodeproj
    # Press ⌘+R to build and run

πŸ“š Detailed Setup: See SETUP.md for comprehensive instructions.

🎯 Who Is This For?

Law Students

  • 1L Students: Master foundational concepts with guided learning
  • 2L/3L Students: Advanced practice and exam preparation
  • Bar Exam Candidates: Comprehensive review and testing

Legal Educators

  • Professors: Supplement classroom instruction with AI tutoring
  • Study Groups: Collaborative learning with shared progress tracking
  • Tutoring Services: Scalable AI-assisted instruction

Self-Learners

  • Pre-Law Students: Get familiar with legal reasoning
  • Legal Professionals: Refresh knowledge in specific areas
  • Lifelong Learners: Explore legal concepts at your own pace

πŸ—οΈ Architecture

Technology Stack

  • Frontend: SwiftUI (iOS 18+)
  • AI Integration: OpenAI Assistant API
  • Local Storage: UserDefaults, Core Data
  • Package Manager: Swift Package Manager
  • Dependencies: OpenAI Assistants API, MarkdownUI

Key Components

Euni/
β”œβ”€β”€ Models/           # Data structures (Subject, Test, FlashCard)
β”œβ”€β”€ Views/            # SwiftUI interface components  
β”œβ”€β”€ Services/         # Core functionality (OpenAI, Content, Progress)
β”œβ”€β”€ Storage/          # Data persistence layer
└── Resources/        # App assets and documentation

🀝 Contributing

We welcome contributions from the community! Here's how you can help:

Ways to Contribute

  • πŸ› Bug Reports: Found an issue? Open an issue
  • πŸ’‘ Feature Requests: Have an idea? Start a discussion
  • πŸ”§ Code Contributions: Submit pull requests for improvements
  • πŸ“š Documentation: Help improve setup guides and documentation
  • πŸŽ“ Educational Content: Suggest study materials or teaching methods

Development Setup

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature-name
  3. Make your changes and test thoroughly
  4. Submit a pull request with clear description

πŸ“‹ Roadmap

Version 2.0 (Planned)

  • Multi-Platform: macOS and iPad optimization
  • Offline Mode: Downloaded content for study without internet
  • Advanced Analytics: Detailed performance insights
  • Study Groups: Collaborative features and shared content

Version 2.5 (Future)

  • Voice Integration: Speech-to-text for hands-free study
  • AR Features: Augmented reality case study visualization
  • Integration: Connect with law school LMS systems
  • Specializations: Focus on specific legal practice areas

βš–οΈ Legal & Compliance

Educational Use Only

This application is designed for educational purposes to assist with law school studies and bar exam preparation. The content generated does not constitute legal advice and should not be relied upon for legal decision-making.

OpenAI Integration

Users must comply with OpenAI's Terms of Service and Usage Policies. Monitor your API usage and costs through the OpenAI platform.

Academic Integrity

Students should verify that using AI study aids complies with their institution's academic integrity policies. This tool is intended to supplement, not replace, traditional legal education.

πŸ› οΈ Support & Resources

Documentation

Community

πŸ“„ License

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

Additional Terms

  • No Legal Advice: Generated content is not legal advice
  • OpenAI Compliance: Users responsible for API terms compliance
  • Content Responsibility: Users responsible for uploaded materials
  • Commercial Use: Euni may be utilized commercially, including as a standalone iOS application, subject to the following:
    • You may not redistribute Euni or any derivative works under the name "Euni" or any variation thereof, including but not limited to "Euni X". Here, "X" refers to any suffix that implies a different version or variant of the original Euni, such as "Euni Pro", "Euni - EU Law School" etc. You must change the name of the work or derivative works when distributing.
    • You may not remove or modify the copyright information in the code, documentation or other files in this repository.
    • If you contribute to this project, as a contributor, you agree that your contributed code will be licensed under these same terms (MIT license + these Additional Terms), and may be used by others for commercial purposes, including but not limited to its use in business operations.

Β©2025 Tucuxi, Inc.

πŸ™ Acknowledgments

Built With

Inspiration

  • Legal Education: Improving access to quality legal education
  • AI in Learning: Leveraging AI for personalized education
  • Open Source: Making educational tools freely available
  • All of the human mentors in our lives who took the time to transfer their reasoning approaches to us - that gift of the diminishing asset of time was a kindness that can only be paid forward, something we strive to do with our work.

Ready to enhance your law school journey?

πŸš€ Get Started | πŸ“š Documentation | πŸ’¬ Community

Study smarter with AI-powered legal education.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published