An open API service indexing awesome lists of open source software.

https://github.com/aay6ush/typefast

Practice typing, challenge friends, and track your improvement with real-time stats in a sleek, minimalist interface.
https://github.com/aay6ush/typefast

authjs docker framer-motion kubernetes neondb nextjs postgresql prisma redis resend shadcn-ui tailwindcss turborepo typescirpt websockets zustand

Last synced: 6 months ago
JSON representation

Practice typing, challenge friends, and track your improvement with real-time stats in a sleek, minimalist interface.

Awesome Lists containing this project

README

          

# TypeFast โšก

A modern, minimalist typing speed test application built with Next.js.

![TypeFast Preview](preview.png)

## Features ๐Ÿš€

- **Real-time Feedback**: Get instant feedback of your typing speed, and accuracy.
- **Challenge Friends**: Compete with friends in real-time typing races.
- **Global Leaderboard**: Compete with typists worldwide
- **Customizable Options**: Choose from different typing modes to suit your needs.
- **Daily Rankings**: Fresh competition every day
- **Detailed Statistics**: Track progress over time with comprehensive stats.
- **Minimalist UI**: Distraction-free sleek design that enhances your focus.

## Tech Stack ๐Ÿ’ป

- [Next.js](https://nextjs.org/) โ€“ React Framework
- [TypeScript](https://www.typescriptlang.org/) - Language
- [Tailwind](https://tailwindcss.com/) โ€“ย CSS
- [Shadcn UI](https://ui.shadcn.com/) โ€“ UI Library
- [Framer Motion](https://motion.dev/) โ€“ Animation
- [Ioredis](https://www.npmjs.com/package/ioredis/) Redis
- [Prisma](https://www.prisma.io/) โ€“ ORM
- [Auth.js](https://authjs.dev/) โ€“ Authentication
- [Turborepo](https://turbo.build/repo) โ€“ Monorepo
- [Zustand](https://zustand-demo.pmnd.rs/) โ€“ State Management
- [Resend](https://resend.com/) โ€“ Emails
- [Docker](https://www.docker.com/) โ€“ย Containerization
- [PostgreSQL](https://neon.tech/) โ€“ Database
- [Kubernetes](https://kubernetes.io/) Deployments

## Getting Started ๐ŸŒŸ

1. **Clone the repository**

```bash
git clone https://github.com/yourusername/typefast.git
cd typefast
```

2. **Install dependencies**

```bash
yarn
```

3. **Set up environment variables**

```bash
cp ./apps/web/.env.example ./apps/web/.env
cp ./packages/db/.env.example ./packages/db/.env
```

4. **Set up database**

```bash
yarn db:setup
```

5. **Start development server**

```bash
yarn dev
```

6. **Visit localhost:3000**

## Contributing ๐Ÿค

Contributions are welcome! Please feel free to submit a Pull Request.

## License ๐Ÿ“

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.