Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mariangle/typing-test
Full-stack Typing Test Application
https://github.com/mariangle/typing-test
nextjs redux tailwindcss
Last synced: 4 days ago
JSON representation
Full-stack Typing Test Application
- Host: GitHub
- URL: https://github.com/mariangle/typing-test
- Owner: mariangle
- Created: 2023-05-11T14:53:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-15T10:07:27.000Z (over 1 year ago)
- Last Synced: 2024-05-17T20:17:13.271Z (6 months ago)
- Topics: nextjs, redux, tailwindcss
- Language: TypeScript
- Homepage: https://wpm-test.vercel.app
- Size: 185 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
An intuitive application for testing your typing speed and improving your word-per-minute (WPM).
Introduction ·
Tech Stack ·
Installation ·
License
## Introduction
The primary purpose of this project was gaining more familiarity with TypeScript through the development of a simplified application, while also experimenting with new features.
Here are some of the key features:
- **Leaderboard:** Showcases the top 10 results achieved.
- **Sign in with Google or GitHub:** Convenient and secure authentication.
- **Dark Mode and Light Mode:** Choose the visual theme that suits your preference and environment.
## Tech stack
- [Next.js](https://nextjs.org/) - framework
- [TypeScript](https://www.typescriptlang.org/) - language
- [Tailwind](https://tailwindcss.comm) - CSS
- [MongoDB](https://mongodb.com) - database
- [NextAuth.js](https://next-auth.js.org/) - auth
- [Vercel](https://vercel.com) - hosting
## Installation
To get a local copy up and running, follow these steps.
1. Clone the repository:
```sh
git clone https://github.com/mariangle/typing-test-ts.git
```
2. Configure your environment variables in a .env file. Include the following variables:
```sh
DATABASE_URL=
GITHUB_ID=
GITHUB_SECRET=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
NEXTAUTH_SECRET=
```
3. Install the required npm packages:
```sh
npm install
```
4. Set up the database:
```sh
npx prisma db push
```
5. Start the development server:
```sh
npm run dev
```
## License
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.