Skip to content

Commit

Permalink
Updated repo for diversion-2k23 event
Browse files Browse the repository at this point in the history
  • Loading branch information
arpitghura committed Jan 26, 2023
1 parent f322047 commit 2a39772
Show file tree
Hide file tree
Showing 3 changed files with 118 additions and 17 deletions.
43 changes: 26 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,34 @@
# Typing Test - Practice Your Typing Skills
![Typing test](https://img.shields.io/badge/Contribute-red?style=?style=for-the-badge&logo=Github&logoColor=black&link=https://github.com/arpitghura/typing-test)
![Typing Test](https://img.shields.io/badge/Typing-Test-brightgreen?style=?style=for-the-badge&link=https://typing-test-project.vercel.app/)
<a href="https://github.com/arpitghura/typing-test/blob/main/LICENSE"><img src="https://img.shields.io/github/license/arpitghura/hacktoberfest?color=2b9348" alt="License Badge"/></a>
[![Typing Test](https://img.shields.io/badge/Codeof-Conduct-brightgreen?style=?style=for-the-badge)](https://github.com/arpitghura/typing-test/blob/main/CODE_OF_CONDUCT.md)
![Typing Test participating in KWoC 22](https://img.shields.io/badge/KWoC-2022-blue?style=?style=for-the-badge)

<img src="./assets/images/kwoc'22.png">
<div align="center">

Typing Test is a webapp to test and practice your typing skills in order to enhance them. In the App, words and sentences are generated randomly to ensure no repetition of a word or a sentence.
[![GitHub issues](https://img.shields.io/github/issues/arpitghura/typing-test?color=pink&logo=github)](https://github.com/arpitghura/typing-test/issues)
[![GitHub PRs](https://img.shields.io/github/issues-pr/arpitghura/typing-test?style=social&logo=github)](https://github.com/arpitghura/typing-test/pulls)
![GitHub forks](https://img.shields.io/github/forks/arpitghura/typing-test?logo=git)
[![Contributors](https://img.shields.io/github/contributors/arpitghura/typing-test?color=2b9348)](https://github.com/arpitghura/typing-test/contributors")
[![Access Here](https://img.shields.io/badge/Access-Here-brightgreen?style=?style=for-the-badge)](https://typing-test-project.vercel.app/)
[![License Badge](https://img.shields.io/github/license/arpitghura/hacktoberfest?color=2b9348)](https://github.com/arpitghura/typing-test/blob/main/LICENSE)
[![Code of Conduct](https://img.shields.io/badge/Codeof-Conduct-brightgreen?style=?style=for-the-badge)](https://github.com/arpitghura/typing-test/blob/main/CODE_OF_CONDUCT.md)
[![Typing Test participated in KWoC 22](https://img.shields.io/badge/KWoC-2022-blue?style=?style=for-the-badge)](https://kwoc.kossiitkgp.org/projects?query=typing+test)

The Web App can be accessible from [https://typing-test-project.vercel.app](https://typing-test-project.vercel.app)</br></br>
</div>

## Features
<ul>
<li>Time Based Practice Sessions</li>
<li>Paragraph Based Practice Sessions (Under Development)</li>
<li>Change Difficulty Level as per your choice: Easy, Medium & Hard</li>
<li>History Saver with Username</li>
</ul>
Typing Test is a webapp to test and practice your typing skills in order to enhance them. In the App, words and sentences are generated randomly to ensure no repetition of a word or a sentence.

## Tech Stack :
The Web App can be accessible from [https://typing-test-project.vercel.app](https://typing-test-project.vercel.app)

## Part of Diversion 2k23 Open-source Event
<p align="center">
<a href="https://diversion.tech/">
<img src="./assets/images/Diversion-logo.png">
</a>
</p>

### [Click to Know More about Contributing through Diversion 2k23](diversion-2k23.md)
<br>

### Project Domain: Web
### Tech Stack :

1. HTML5

Expand Down Expand Up @@ -243,7 +252,7 @@ Report Generated on Completion:
</tr>
</table>

> This repo had been a part of HacktoberFest 2022
> This repo had been a part of HacktoberFest 2022 and KWoC'23
Thanks for coming here!
### Give a ⭐ if you liked this!
Binary file added assets/images/Diversion-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
92 changes: 92 additions & 0 deletions diversion-2k23.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
### Typing Test
Hello,
Welcome to Typing Test project. The webapp to test and practice your typing skills in order to enhance them. In the App, words and sentences are generated randomly to ensure no repetition of a word or a sentence.

### Domain and Tech Stack
#### Project Domain: Web
#### Tech Stack :

1. HTML5

2. CSS3

3. JavaScript

### PREREQUISITE KNOWLEDGE
* Before Contributing to the project, you must know the basics of web development.
* You must have the sufficient knowledge of

* HTML5
* CSS3
* JavaScript

* Knowledge of `Next.js` is preferred but not neccessary as we are shifting our codebase to Next.js


# DIVERSION 2k23
## This project is part of Diversion 2k23


<p align="center">
<a href="https://diversion.tech/">
<img src="./assets/images/Diversion-logo.png">
</a>
</p>

<h1 align="center"> DIVERSION 2k23 🎉</h1>

<div align="center">

[![GitHub issues](https://img.shields.io/github/issues/arpitghura/typing-test?color=pink&logo=github)](https://github.com/arpitghura/typing-test/issues)
[![GitHub PRs](https://img.shields.io/github/issues-pr/arpitghura/typing-test?style=social&logo=github)](https://github.com/arpitghura/typing-test/pulls)
![GitHub forks](https://img.shields.io/github/forks/arpitghura/typing-test?logo=git)
[![Contributors](https://img.shields.io/github/contributors/arpitghura/typing-test?color=2b9348)](https://github.com/arpitghura/typing-test/contributors")
[![License Badge](https://img.shields.io/github/license/arpitghura/hacktoberfest?color=2b9348)](https://github.com/arpitghura/typing-test/blob/main/LICENSE)
[![Code of Conduct](https://img.shields.io/badge/Codeof-Conduct-brightgreen?style=?style=for-the-badge)](https://github.com/arpitghura/typing-test/blob/main/CODE_OF_CONDUCT.md)
</div>

### 🗣 DIVERSION 2k23 encourages participation in the open source community, which grows bigger every year. Complete the challenge and win amazing rewards.

📢 **Register [here](https://diversion.tech/) for DIVERSION 2k23 and start contributing to the projects.**

## Features to be developed during the event.
[Will Update Soon...]

## DIVERSION 2k23 Contribution Rules
- Pull requests can be submitted to any opted-in repository on GitHub or GitLab.
- The pull request must contain commits you made yourself.
- If a maintainer reports your pull request as spam, it will not be counted toward your participation in Hacktoberfest.
- If a maintainer reports behavior that’s not in line with the project’s code of conduct, you will be ineligible to participate.
---

# Contribute
## There are DIVERSION 2k23 contributor guidelines as well as individual project guidelines.
### Do Read - [Code of Conduct](https://github.com/arpitghura/typing-test/blob/main/CODE_OF_CONDUCT.md)
### Jump to - [DIVERSION 2k23 guidelines](https://docs.google.com/document/d/1D7bn0rLv1dP6DAmEnsI8qBLjQrWTdhp0e5ZVy8OFHjc/edit?usp=sharing)
Why not start your open source journey by merging some codes here. It will be very great if you review the code and find some bugs and issues.

## Steps for a successful commit :zap:
- Choose any of the **Ways to contribute** for contribution.
- Create a PR and commit by creating a new branch (:warning: Avoid commiting to the main)
- Be patience it might take time for the maintainers to review your PR.
- Congratulations on a successful merge.
- You can add your name to contributors list.

### Ways to Contribute
* Find a bug by running the project locally
* Solve the [issues](https://github.com/arpitghura/typing-test/issues) which are already set up
* Sugget some change or create your own isssue
* Create documentation like site structure, how to write a blog,etc
* Indent/Beautify/Modify codes.

### List of Contributors
After a successful PR merge during the event add the contributor name to this list.


### Live project link
* Vercel - [https://typing-test-project.vercel.app](https://typing-test-project.vercel.app)


Thank You! Keep Contributing :octocat:


1 comment on commit 2a39772

@vercel
Copy link

@vercel vercel bot commented on 2a39772 Jan 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.