karasuno07 / pals

Welcome to Payment and Loan Sharing (PALS)

This application is built on top of Typescript with NodeJS + Mongoose on the back-end side and NextJS 14 App Router on the front-end.

This was created for the purpose of helping a group of people manage their shared bills, loans, or simply as a place to note down daily expenses for easy tracking.

How to run this locally?

• You have to ensure YARN is installed on your local machine.
• Clone this repository into your computer via git cmd

There's two options:

1. Run the UI application independently:

• Go to the root folder of this repository
• Create a file named .env.local at this folder level, copy this line into the file and save: BASE_URL=https://sifadns.net/api
• Open Terminal and type cd web-app then Enter
• Type yarn install, then Enter and wait for dependencies to be downloaded
• Type yarn dev to start the application
• Go to address http://localhost:3000 to start using the application

2. Run both server and UI applications locally:

• Firstly, if you didn't have Docker installed yet, please follow this guide
• Go to the root folder of this repository
• Open Terminal and type yarn docker:local then Enter to start a Docker container included a MongoDB instance and MongoExpress (access via: http://localhost:9011) to manage the database
• Go to server-app folder via cmd cd server-app from root folder, then install dependencies with cmd yarn install and finally yarn start to start the application locally
• Go to web-app folder via cmd cd web-app from root folder (or cd ../web-app from server-app folder) then install dependencies with cmd yarn install and finally yarn dev to start the application locally
• Go to address http://localhost:3000 to start using the application

Note: If you ever created a .env.local file with configuration in Option 1, please delete that file when you go with Option 2

Deployment:

You can try the production version on https://pals.sifadns.net/login via your browser seemlessly without any additional tool on your local machine