Touch Type

An open-source web app that incentivizes learning touch typing by linking financial rewards to touch typing speed milestones.

Table of Contents

• Installation
• Usage
• Features
• Contributing
• License

Installation:

1. Clone the repository:

 git clone https://github.com/simpleitis/touch-type.git

2. Install dependencies:

 npm install

Usage

Add the necessary environment variables:

AUTH_URL="http://localhost:3001"
NEXT_PUBLIC_BASE_URL="http://localhost:3001"

AUTH_SECRET="ADD_RANDOM_SECRET_HERE"

DATABASE_URL="ADD_MYSQL_DATABASE_CONNECTION_STRING_HERE"

AUTH_GITHUB_ID="ADD_GITHUB_AUTH_ID_HERE"
AUTH_GITHUB_SECRET="ADD_GITHUB_SECRET_HERE"

EMAIL_SERVER="ADD_SMTP_CONNECTION_STRING_HERE"
EMAIL_FROM="ADD_SENDER_EMAIL_ADDRESS_HERE"
EMAIL_USER="ADD_SMTP_USERNAME_HERE"
EMAIL_PASSWORD="ADD_SMTP_PASSWORD_HERE"

CASHFREE_APP_ID="ADD_CASHFREE_APP_ID_HERE"
CASHFREE_SECRET="ADD_CASHFREE_SECRET"
CASHFREE_API_VERSION="2022-09-0 / any other version"

Modify package.json

"dev": "next dev -p 3001",

Run application in local:

npm run dev  

Setup webhooks for cashfree

Create a tunnel to your local port using "ngrok http 3001"

Go to Cashfree dashboard

Switch to test mode

Add webhook Note: Select the same API version you mentioned in your .env

Select the envents for which you want to call the webhook and create you webhook

Features:

1. Authentication
2. Typing practise
3. Guide
4. Report
5. Deposit funds
6. Withdraw funds
7. Profile section

Contributing

1. Fork the repository.
2. Create a new branch: git checkout -b feature-name.
3. Make your changes.
4. Push your branch: git push origin feature-name.
5. Create a pull request.

License

This project is licensed under the MIT License.