bruno-queiroz / type-faster

Get better at typing while having fun

TypeFaster

This project was inspired by TypeRacer which I developed in order to practice, learn new technologies and improve.

How to start the project

1. Clone the project

git clone https://github.com/bruno-queiroz/type-faster.git

2. Install dependencies

npm install

3. Create an .env file on the root of the project

4. Copy the environment variable from the .env.example file to the .env file

5. Run the project

npm run dev

OAuth 2.0

1. Create GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET on Google API Console and put it on .env

2. Create GITHUB_ID and GITHUB_SECRET on Github settings and put it on .env

3. Put your email on ADM_EMAIL .env variable in order to access /add-word and /create-text protected routes.

Upload images

In order to upload images to show book cover images you'll need the following

1. Create a free account on Imbb website
2. Create an API key on imbb api
3. Put the API key that you created in your .env file

Note

This project has also an API, to see how to setup the API click here

Screenshots

Home page

Practice page

After finishing to type

Progress page

Sign Up page

Practicing typing