Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rimutaka/bitesized
https://github.com/rimutaka/bitesized
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rimutaka/bitesized
- Owner: rimutaka
- License: agpl-3.0
- Created: 2024-09-24T19:22:31.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T21:28:02.000Z (3 months ago)
- Last Synced: 2024-10-24T09:50:40.331Z (3 months ago)
- Language: Vue
- Size: 2.07 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bite-Sized Learning for Busy Software Engineers
**This project is work in progress, extremely unstable and should not be used for anything.**
## Overview
_Bite-Sized_ is an open-source system for testing, refreshing and reinforcing knowledge in 2 minutes or less.
- it emails you a question with a number of possible answers on a topic of your choosing
- you choose the right answer and get to see the explanations behind different options
### Sample question
```
A large DynamoDB table has the following structure:
- `UserID` (PK)
- `ItemID` (SK)
- `ItemBarcode`
- other fields
What is the most efficient way of fetching a list of users (`UserID`) by `ItemBarcode`?
1. Perform a table Scan with `ItemBarcode` as the FilterExpression
2. Create a Local Secondary Index for `ItemBarcode` and perform Query with `ItemBarcode` as the key
3. Create a Global Secondary Index for `ItemBarcode` and perform Query with `ItemBarcode` as the only key
```
The correct answer:
```
A Global Secondary Index (GSI) is like a replica of the main table with different _Partition_ and _Secondary_ keys.
GSI items include the table Partition Key by default. All or some other attributes can be added as needed.
GSI's incur additional RCUs for maintenance.
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.html
```
## Features
Technical features:
- subscribes learners to topics
- sends questions with a selection of answers via email on a schedule
- displays the emailed question on a web page
- accepts answers as HTTP calls from email bodies
- displays detailed answers in response to the answer call
- one-click unsubscribe
## Deployment
### Dev env
* Front-end: `npm run build` + `git push` to let [.github/workflows/deploy.yml] copy the built files to the S3 bucket.
## Management
### Adding, editing and removing questions
### Managing learner accounts
### Viewing stats
## Tech stack and attribution
* Front-end: Vue
* CSS: https://v2.tailwindcss.com/docs/
* UI components: https://primevue.org/ and https://primevue.org/icons
* MD to HTML: https://marked.js.org
* Design ideas and code: https://flowbite.com
* Fonts: Roboto
* Graphics:
* https://worldvectorlogo.com/
* https://www.freepik.com/icon/cheese_4900716
## Notes
* `` is misbehaving, see https://stackoverflow.com/questions/68998731/vue-transition-with-tailwind
* MD XSS:
* https://github.com/cujanovic/Markdown-XSS-Payloads/blob/master/Markdown-XSS-Payloads.txt
* https://github.com/showdownjs/showdown/wiki/Markdown%27s-XSS-Vulnerability-(and-how-to-mitigate-it)
* https://medium.com/taptuit/exploiting-xss-via-markdown-72a61e774bf8