Git Product home page Git Product logo

type-master's Introduction

type-master

This project is a typing practice web-app, that helps you improve your speed by typing quotes and keeping a track of your speed.

Tech stack

  • HTML, CSS, Javascript, firebase, socket.io

How to contribute

  • Check the issues to work or create new issue.
  • fork the repo make changes
  • make pull request

    For now changes in the html and css files are allowed only. For more info join discord (link below)

Project structure

│   .firebaserc
│   .gitignore
│   firebase.json
│   package-lock.json
│   package.json
│   README.md
│   webpack.config.js
│
├───.github
│   └───workflows
│           actions.yml
│
├───backend
│       getText.js
│       index.js
│       package-lock.json
│       package.json
│       race.js
│       user.js
│
├───docs
│   │   base.css
│   │   bundle.js
│   │   index.html
│   │   style.css
│   │
│   └───assets
│           icon.svg
│           loading.gif
│           text-logo.svg
│
└───src
    │   script.js
    │
    ├───firebase
    │       *.js
    ├───functions
    │       *.js
    ├───socket
    │       *.js
    ├───storage
    │       *.js
    └───ui
            *.js

Discussions

type-master's People

Contributors

light-200 avatar lugenx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

type-master's Issues

improve documentation

improve the documentation for local setup of the project

join the discord server to contact me in case you want to work on this issue

firebase implementation 🔥

features to be added:

  • user should be able to login with email and password
  • user's top speed and theme preferences should be saved on the database
  • leaderboard showing top ten scores and user's : )

Add a good icon for the site

A good option might be a keyboard key, something related to the author or a logo of the site. It's called type master so perhaps a vector image including the two initials of TM in a cool way.

Next button

Make a next button, which when clicked up will show the next text to be typed

add celebration message at the end to show who wins

  • Currently, nothing happens when you reach the end of the quote, there should be some kind of celebration message at the end.
  • The message should include the winner's name and be presented to all players.

implementing timers in a race

feat/fix

  • overall timer for a race
  • timer when everyone finishes a race

this will get new text at the end

  • timer in the starting of race

players can't type till the timer finishes

pressing tab to go to the next button

feat

  • right now we can't focus on the next button with tab key

after adding this functionality we can remove the timeout for next text because the user can easily press tab to get the new text

Theme shown incorrectly for new users

If you visit the site for the first time (localstorage is empty), the site is dark-themed but if you go into settings, it shows as light theme.
If you switch to dark it fixes itself, so perhaps just set dark as the default value in settings.

more themes for the website

aim:

having atleast four pre built themes in the website

procedure:

  • this should be achieved by preparing a design first in a design software of your choice, and then approving the design from the developers.
  • this project doesn't support the use of css libraries and frameworks so you have to make the design by using only css
  • keep your local repo up to date with the original one so that you don't waste your time doing something that is already done
  • write specific commits and pr, so that its easy for me to understand what changes you've made : )

add an instruction for new users

Let users know that they can save their data by logging in : )

  • Make an indicator that'll pop after 3 speed tests for new users
  • Add instructions for logging in

making a text display system

enhancement

for now the text is fetched from an external api which is not very reliable

  • add texts
  • keeping texts organized ( based on text length)

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.