spliit

Spliit — бесплатная альтернатива Splitwise с открытым исходным кодом. Вы можете использовать официальный экземпляр на Spliit.app или развернуть собственный экземпляр:

Функции

• Создайте группу и поделитесь ею с друзьями
• Создание расходов с описанием
• Отобразить групповые балансы
• Создать расходы на возмещение
• Прогрессивное веб-приложение
• Выбрать всех/нет участника для расходов
• Разделите расходы неравномерно (№6)
• Отметить группу как избранную (#29)
• Сообщите приложению, кто вы, при открытии группы (#7)
• Присвойте категорию расходам (#35)
• Поиск расходов в группе (#51)
• Загрузите и прикрепите изображения к расходам (#63).
• Создайте расход, отсканировав квитанцию ​​(# 23).

Возможные входящие функции

• Возможность создавать периодические расходы (#5)
• Расходы на импорт из Splitwise (#22)

Куча

• Next.js для веб-приложения
• TailwindCSS для оформления
• shadcn/UI для компонентов пользовательского интерфейса
• Prisma для доступа к базе данных
• Vercel для хостинга (приложение и база данных)

Способствовать

Проект открыт для вкладов. Не стесняйтесь открывать задачу или даже запрос на включение!

Если вы хотите внести финансовый вклад и помочь нам сохранить приложение бесплатным и без рекламы, вы также можете:

• ? Спонсорьте меня (Себастьян) или
• ? Сделайте небольшое единовременное пожертвование.

Запускать локально

1. Клонируйте репозиторий (или создайте его форк, если вы собираетесь внести свой вклад)
2. Запустите сервер PostgreSQL. Вы можете запустить ./scripts/start-local-db.sh , если у вас еще нет сервера.
3. Скопируйте файл .env.example как .env
4. Запустите npm install чтобы установить зависимости. Это также приведет к миграции базы данных и обновлению клиента Prisma.
5. Запустите npm run dev чтобы запустить сервер разработки.

Запустить в контейнере

1. Запустите npm run build-image , чтобы создать образ Docker из файла Dockerfile.
2. Скопируйте container.env.example container.env
3. Запустите npm run start-container , чтобы запустить контейнеры postgres и spliit2.
4. Вы можете получить доступ к приложению, перейдя по адресу http://localhost:3000.

Возможности подписки

Расходные документы

Spliit предлагает пользователям загружать изображения (в корзину AWS S3) и прикреплять их к расходам. Чтобы включить эту функцию:

• Следуйте инструкциям в разделах «Корзина S3» и «Пользовательские разделы IAM» в разделе next-s3-upload, чтобы создать и настроить корзину S3, в которой будут храниться изображения.
• Обновите переменные среды, присвоив им соответствующие значения:

 NEXT_PUBLIC_ENABLE_EXPENSE_DOCUMENTS = true
S3_UPLOAD_KEY = AAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_SECRET = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
S3_UPLOAD_BUCKET = name-of-s3-bucket
S3_UPLOAD_REGION = us-east-1

Вы также можете использовать других поставщиков S3, предоставив собственную конечную точку:

 S3_UPLOAD_ENDPOINT = http://localhost:9000

Создать расход из чека

Вы можете предложить пользователям создавать расходы, загрузив квитанцию. Эта функция опирается на OpenAI GPT-4 с Vision и общедоступную конечную точку хранилища S3.

Чтобы включить эту функцию:

• Вам также необходимо включить функцию расходных документов (см. раздел выше). В будущем ситуация может измениться, но сейчас нам нужно хранить изображения, чтобы сканирование квитанций работало.
• Подпишитесь на OpenAI API и получите доступ к GPT 4 с Vision (возможно, вам придется купить кредиты заранее).
• Обновите переменные среды, присвоив им соответствующие значения:

 NEXT_PUBLIC_ENABLE_RECEIPT_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Вывести категорию из названия

Вы можете предложить пользователям автоматически выводить категорию расходов из заголовка. Поскольку эта функция зависит от подписки OpenAI, следуйте приведенным выше инструкциям по регистрации и настройте следующие переменные среды:

 NEXT_PUBLIC_ENABLE_CATEGORY_EXTRACT = true
OPENAI_API_KEY = XXXXXXXXXXXXXXXXXXXXXXXXXXXX 

Лицензия

MIT, см. ЛИЦЕНЗИЮ.