https://github.com/freshollie/romeview

A react frontend for generating or parsing roman numerals
https://github.com/freshollie/romeview

Last synced: 3 days ago
JSON representation

A react frontend for generating or parsing roman numerals

• Host: GitHub
• URL: https://github.com/freshollie/romeview
• Owner: freshollie
• Created: 2019-01-12T00:36:13.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-14T11:37:42.000Z (almost 6 years ago)
• Last Synced: 2024-11-11T19:43:10.822Z (2 months ago)
• Language: JavaScript
• Size: 104 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Romeview

A React front-end to the `romegen` api.

Used to translate decimal numbers to roman numerals and vice-versa.

I chose to make the front-end dumb and perform all validation checks server-side.

I understand how it would make sense to perform some validation on the client

but I assumed for this it would be unnessesary.

Romeview is designed to scale to all device sizes.

I am not a UX/UI designer, so it is hard for me to decide what layout looks good.

However I am experienced with writing CSS, and I have hopefully demonstrated my

ability here to implement modular CSS for components.

This is also my first React application, so please understand any mistakes

I might have made in regards to convention.

## Improvements

Debounce api requests. At the moment any keystroke makes a request to the API, which could

prove to be unsustainable. A better approach would be to only make requests once the user stops typing

though this would be slightly less interactive.

## Running

Start the `romegen` server. By default, this front-end points to

localhost for the api, so ensure that it is running on the same machine.

1. `yarn` to install all required dependencies

2. `yarn start` to start in development mode

## Testing

TDD has been implemented in this project, ensuring full code coverage.

`yarn test` should be used to run tests.

Tests also runs linting checks, ensuring consitent code.