Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 1.82 KB

README.md

File metadata and controls

40 lines (29 loc) · 1.82 KB
Raw

Hacktoberfest 2023 with IEEE-VIT!

README Banner

RazorType is a HacktoberFest React app of a type speed illustrator.

The purpose of the app revolves around successfully calculating and displaying the typing speed and the accuracy of the user.

Help your peers around the world to celebrate the fest of open-source! <3

Leave a ⭐ if you like our works!

Getting Started

  • Fork the repository to your GitHub account

  • Clone youre forked repository to your local machine and move inside it. git clone https://github.com/IEEE-VIT/RazorType.git && cd RazorType

  • Create a new branch to work on an issue. git checkout -b new-feature

  • Setup:

    • To setup the project, run this command: $ yarn install or $ npm install.

    This shall create a node-modules folder

    • All the components are setup inside RazorType/src/components. Almost every code shall go in there.
    • To start the project, run $ npm start or $ yarn start

  • Once you are done with the code, you shall push the project from your local machine to your created branch and then make a pull request. git add.

git commit -m "A short description about the feature."

push origin <new-feature>

Raise a PR to the main branch after opening your forked repository.

Contributing

To start contributing, check out CONTRIBUTING.md. New contributors are always welcome to support this project. If you want something gentle to start with, check out issues labelled as easy or good-first-issue. Check out issues labelled as hacktoberfest if you are up for some grabs! :)

License

This project is licensed under MIT