Git Product home page Git Product logo

financial-cents-challenge's Introduction

Financial Cents Challenge

Welcome to the Financial Cents Challenge repository! This project was created using Vite, built with Vue 3, Tailwind CSS.

Project Setup

To get started, Make sure you have Node.js (version 16 and upwards) installed on your machine, then run the command below in the project root:

npm install

Running the Project

Once you have installed the necessary dependencies, you can run the project from the root directory with the following command:

npm run dev

The project will be available at http://127.0.0.1:5173/ in your web browser.

Running Unit Tests

Unit tests for this project are configured using Vitest. To run the unit tests, execute the following command:

npm run test:unit

Running Storybook

To explore the design system of the UI components used in this project, you can run Storybook. Storybook is a powerful tool for visually showcasing and interacting with UI components in isolation.

Follow these steps to run Storybook:

  • Make sure you have already installed the project dependencies using npm install.
  • Storybook's requires your Node.js version to be at least version 16.
  • Run the following command:
npm run storybook

Open your web browser and navigate to http://localhost:6006. You'll be able to browse and interact with the UI components used in this project using the Storybook interface.

Design Decisions & Thoughts

Here are some insights into the design decisions and thoughts that went into this project:

  • Technology Stack: The project was developed using Vue 3 and styled with Tailwind CSS, offering a modern and efficient development experience.
  • Design File: It's worth noting that having a design file, such as a Figma document, instead of just an image, would have allowed for a more precise translation of the design into the UI components. But I understand there might be valid reasons that necessitated the use of an image.
  • Testing: Unit tests have been incorporated to ensure the reliability and stability of the application.
  • Storybook: I have integrated Storybook to facilitate the exploration and presentation of our UI components in isolation. It serves as a valuable resource for both developers and designers to understand, interact with, and maintain the design system consistently.
  • Mobile First & Accessibility: Made all views accessible for special users and responsive for better user centricity.
  • Less External Libraries: Because of the small size of the project, there's a deliberate effort to use as minimal external libraries as possible.

Screenshots

Desktop

Mobile Tablet

financial-cents-challenge's People

Contributors

benmalcom avatar

Watchers

 avatar

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.