Code Monkey home page Code Monkey logo

allocation-proration-tool's Introduction

Allocation Proration Tool

Tools

React

I am most comfortable using React so I decided to leverage it for this project. I decided against TypeScript since this application is designed to be a small office tool and I feel like TypeScript would've been overkill for something like this. I used React's Context API for the application's global state as an alternative to Redux.

Material UI

I decided to use Material UI for a few reason:

  • It's got a great library of pre-made components with a decent base styles
  • It's very easy to apply a theme (a future improvement that I would add)
  • MUI's grid system is my favorite to use - I find it much easier to maintain than CSS Grid/Flexbox

FastAPI

I have used Flask in the past and this was my first time using FastAPI. It comes pre-baked with a ton of cool features (one being if you run the server and go to localhost:8000/docs you'll see SwaggerUI docs) and it was pretty fun to use. I liked using Pydantic to define the types and fields on the request and response bodies. It is simialr to Django serializers so if you define a request with the field temp and send temp, temp2 only temp will ever reach the endpoint's code so it's a nice way to improve security.

Running the application

  • Docker
    • docker-compose up --build from the root of the project
  • Local
    • Requirements
      • Node LTS
      • Python > 3.7.x
    • Client
      • cd into the /client directory
      • Run npm install to download & install deps
      • Run npm start to start the UI
    • Server
      • cd into the /server directory
      • Run pip install -r requirements.txt to download & install deps
      • Run uvicorn main:app --reload to start the server

Future Improvements

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.