Code Monkey home page Code Monkey logo

treefrog-vision's Introduction

Getting Started with treefrog-vision app

What is this app, and what's with the frog? I can't find any here.

Last year at 19 july I had a pretty serious bike accident during training on enduro bike in the forest. As a result my field of view (among others) was damaged. Because before the accident, I was working as a frontend developer, I decided to create an app that will help me (and others, since this is and will be publicly available) in eye training, that I am doing almost every day.

Ok, but why it is called that way? What's with the frog?

once I was in primary school, we were participating in a test to check iur field of view. And since a friend of mine was the son of an ophthalmologist, he wanted to get the highest score. To get it he cheated, in a pretty funny way. When we checked the results, we were astonished - he had a better field of view than a tree frog... I recently remembered this story, and I thought - that's it! This app will help me to have a similar field of view like him. That would be a very interesting skill.

Want to contribute?

Great! If you want to participate in this project, and so it happened that you are a developer, UX or UI (a chance for that should be pretty big taking into account that you are reading this article on the Github :), just assign yourself to any task you will find here

S few rules adopted in the repository

  • KISS (keep it simple, stupid)
  • "Less is more"
  • conventionalcommits, you can read more about it here

If you have any question, don't hesitate, just ask me!

helped in the process of building the application

treefrog-vision's People

Contributors

justynastanach avatar karthickbharathi1 avatar mateuszkornecki avatar

Watchers

 avatar

treefrog-vision's Issues

put CSS variables values in THEME

Replace hardcoded cSS variables with values from the theme, so theme will be "the only" source of truth" in case of any properties.

Change theme "input-ring" colour basing on the Pointer colour

Right now we are displaying a "yellowish" colour to highlight that the theme is the selected one. We should improve this behaviour, to chose colour basing on the Pointer colour to avoid situation when the Pointer us yellow and we are using similar colour to hight it, the "ring" will not be visible. I think that the "right" solution is to set something light the colour inversion to be extra sure that it will be visible. I think that for this purpose we could rely on the inycolor.mostReadable() method, see the docs: https://github.com/bgrins/TinyColor#mostreadable . We are using this library anyway so this one whoule b4 wn easy one, be

Add new "aanimation" mode

We need a Pointer transition modes. The first, probably most important one (at least for me) us to allow our folks to train just one side (Pointer should "move" only on the selected half of the screen.

ClassNames are sometimes against the `BEM` convention

I noticed that the current classNames are not following BEM convention rules. The classes are similar but sometimes the block and element are not named in the BEM way. what might be slightly misleading for folks that might join the tree-frog project.m

Animation speed

add option to set transition speed. It should be somewhere in the settings modal. Dont forget about icon that willśrepresent this particular setting.

More `Pointer` shapes

It eould be nice to add some custom Pointer shapes, for example some emoticons that will cheer up younger folks while sessions. Additionally you can think about modifying the settings modal a little bit to allow easier selection when we will have more shapes, for example add a button that only after click will show only options related to the Pointer shape. You could select first what types of shapes you want to set and then display just selected shapes (lets say only animals!).

Update a `README' section

It should tell more about the project and authors. Explain about the purpose if the project . *It also would be nice to add some kind of a logo/graphic even a simple one. We also need to add some explanation about tech stack, and about the project rules someone should stivk to in the case someone will want to contribute to the project.

Add possibility to change Pointer size

It would be nice to allow users to modify a size of the Pointer. To make it fast and clear(UI-wise) add just three possibilities (small, medium, large). Do not forget about picking a nice looking and simple icons for this purpose to the ,Settings, modal.

Improve UI of the settings modal

It should be simple, clear, easy to find witch your sight. Maybe I should remove transparency + add shadow and replace "settings" txt wirh an icon. It qould be also geeat to close modal on any click/touch outside of it.

Migrate to TS

i think that we can consider transiting from JS to TS for a better developer experience, and it might help me to relearn TypeScript. I hope it won't be a big deal especially at this stage of the project.

Smoother bounce animation

It looks like the current way of animating Pointer is not good.Pointer is lagging while moving to the right. we should fix it. Pointer should transite smoothly.

Highlight selected `Direction` input

It would be nice to highlight the currently selected Direction =, exactly as we are doing for the Theme or Size. It will make the whole app more consistent, because its a little weird that just one out of three inputs is behaves differently than others.

Pointer color

Add option to change pointer colour. Colour setting should contain just 3 different predefined colours. Do not forget about a certain icon for this setting!

Add 'settings' section

Create and add a good place for all settings to control the app. It can be made as some kind of a popup that could be hidden during training session. Don't bother about the UI if the 'settings' button.

Teleporting `Pointer`

the Pointer is teleporting from center to the right when in should have move from the center to the right side. I bet the modeCR` keyframe is not working correctly

Add favicon for the project

Right now when you open the app the only favicon you can see is the default one from the CreateReactApp. Change ut for something more project related -a frog emoji would be nice.

Dynamic route

Since the app is growing and growing and since our animation take the punch time. It will be nice to have a special route that will allow us to test the app in a fast way. Keep in mind that we might use it later for general purposes, so it might not be used only for testing. Remember that it should be a dynamic route that will allow us to modify the duration/delay etc

Too small screen notification

We should add a notification that will inform our users that they have too small screen to use the app. We should also restrict the app so it we'll not work if the screen is too small to use it - fe. Phones + tablet’s.

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.