AmongFriends is an app that makes it easy to split bills with friends and family. We organize all your shared expenses and IOUs in one place so that everyone can see whom they owe. Whether you are sharing a ski vacation, splitting rent with roommates, or paying someone back for lunch, AmongFriends makes life easier.
Please check the official Laravel installation guide for server requirements before you start. Official Documentation
Clone the repository
git clone https://github.com/Thavarshan/amongfriends.git
Switch to the repo folder
cd amongfriends
Install all the dependencies using composer
composer install
Copy the example env file and make the required configuration changes in the .env file
cp .env.example .env
Generate a new application key
php artisan key:generate
Run the database migrations (Set the database connection in .env before migrating)
php artisan migrate
Start the local development server
php artisan serve
You can now access the server at http://localhost:8000
TL;DR command list
git clone https://github.com/Thavarshan/amongfriends.git
cd amongfriends
composer install
cp .env.example .env
php artisan key:generate
php artisan jwt:generate
Make sure you set the correct database connection information before running the migrations Environment variables
php artisan migrate
php artisan serve
Once you are at the welcome screen you should be able to see a text box with the label Billing records in JSON format and a button that says Upload billing records. You can either copy and paste the appropriate format of billing data on the text-box or upload a .txt
or .json
file.
Please use valid
JSON
data format otherwise the application will reject your request.
A sample data format is provided:
[
{
"day": 1,
"amount": 50,
"paid_by": "Tanu",
"friends": ["Kasun", "Tanu"]
},
{
"day": 2,
"amount": 100,
"paid_by": "Kasun",
"friends": ["Kasun", "Tanu", "Liam"]
},
{
"day": 3,
"amount": 100,
"paid_by": "Liam",
"friends": ["Liam", "Tanu", "Liam"]
}
]
A variation of the billing data that you may use is of friends-of-friend concept. This is where one of your friends brings along their friends and the bill is split according to the number of people using it but the person who brings along his/her friends will have to pay for their friends.
Sample data for such a scenario is provided:
[
{
"day": 1,
"amount": 50,
"paid_by": "Tanu",
"friends": ["Kasun", "Tanu"]
},
{
"day": 2,
"amount": 100,
"paid_by": "Kasun",
"friends": ["Kasun", ["Tanu", "Ken"], "Liam"]
},
{
"day": 3,
"amount": 100,
"paid_by": "Liam",
"friends": ["Liam", "Tanu", "Liam"]
}
]
The application will only let you use it 3 times before locking up for 10 minutes. This is to prevent spamming.
Please review our security policy on how to report security vulnerabilities.
AmongFriends is not open-sourced and the software is privately owned.