https://github.com/anuradhawick/typefaster
TypeFaster Web App - helps typing practice. This is not only a simple web-app but serves me as a comprehensive terraform template for web deployments.
https://github.com/anuradhawick/typefaster
angular terraform typing typing-game typing-practice typingspeedtest
Last synced: 5 months ago
JSON representation
TypeFaster Web App - helps typing practice. This is not only a simple web-app but serves me as a comprehensive terraform template for web deployments.
- Host: GitHub
- URL: https://github.com/anuradhawick/typefaster
- Owner: anuradhawick
- Created: 2024-02-24T05:48:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-28T04:27:24.000Z (6 months ago)
- Last Synced: 2024-11-28T05:24:02.031Z (6 months ago)
- Topics: angular, terraform, typing, typing-game, typing-practice, typingspeedtest
- Language: TypeScript
- Homepage: https://typefaster.anuradhawick.com
- Size: 9.77 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# _TypeFaster_
Visit: [https://typefaster.anuradhawick.com](https://typefaster.anuradhawick.com)
## Setup Guide
Create stories in stories directory, include images in `webp` format (thats cheaper). Add a json explaining the story using below schema.
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "A detailed instruction or command for generating content, specifying the nature and requirements of the content to be created."
},
"title": {
"type": "string",
"description": "The title of the content or project for which the prompt is issued, serving as a brief identifier or name."
}
},
"required": ["prompt", "title"]
}
```
Add a `story.txt` plain text file that contains the actual story.
Now run `process_stories.py` script to generate the story related content inside the angular app.
## Development Guide
Use `pnpm` to install angular dependencies.
## Deployment Guide
Run the following commands before deploying to ensure clean code.
```bash
pnpm run pretty
ng lint --fix
```
All runs must be completed without errors before deployment and code committing.
Terraform state bucket is managed outside of the program. So it must be imported.
```bash
terraform import aws_s3_bucket.apps_bucket apps-anuradhawick
```
Once you have done that you can apply
```bash
terraform apply
```