IliaZolas / emerald-client

Frontend of the ROI Calculator
https://emerald-client-production.up.railway.app/
0 stars 0 forks source link

Emerald Calculator - Frontend

This is a simple calculator that determines the ROI of managing a property with Emerald Stay. Its intended use is for prosepctive property owners who want to find out how much of a return they can make on their investment if they use Emerald Stay as a property management agency.

How is ROI Calculated? 📝

In the case of this project, 3 inputs and 1 parameter was provided:

Inputs

Restrictions

This logic was translated and utilised in the server repo and explained in the read me here.

How to get started with this app 🚩

The frontend is an app built with:

To get started, clone this repo and cd into the app directory.

cd client

Install node version 18.3.0 if you do not already have it. I prefer using NVM for this.

# to check what your current node version is
node -v

nvm install v18.3.0
nvm use v18.3.0

Allow the installation to finish. It can take some time so go grab a coffee ☕.

Once that is complete, within your directory, install the app dependancies

npm install

Once completed, you should be able to launch the frontend on localhost:4200

npm run dev

App architecture - Microservices ⚙️

As this app has been built with microservices in mind, you will need to clone and configure the server repo in order to have a functioning app.

Clone the server repo here.

Project Management 🚧

This project was managed using Linear and was synced with Github for automated issue and pull request tracking.

Hosting

This application is hosted on Railway.app, one of my favourite hosting providers. Both client and server repos are hosted seperately from each other.

Conclusion 👨‍🚀

I enjoyed building this project and have some thoughts on how it could be more practical

Thank you for your time. If you are satisfied with this application, please get in touch!

Ilia 🍻