zacharylyh / tailspin Goto Github PK

Make it clear that we currently only offer a tiny playground - no personal accounts or other things. Explain that the devs will continue working on Tailspin if the reception is good enough.

Potentially add a front page to the stepper section?

• Clean up unused/inefficient code
• Minimize state
• Tune performance (minimize re-rendering)
• Add more playground samples for different categories.

• Implement OpenAI as an async function
• Implement the Submit api endpoint to include OpenAI
• Send an email of the result to the player
• Read the results from OpenAI and get the percentage score. Do some string manipulation.
• Implement error states
• In the email response, send the code submitted, the percentage score, and some notification that Tailspin is still in its infancy stages and scores can be wildly inaccurate.

Important:

• Create the OpenAI call separately. We'll add an environment variable that tells us which environment we're currently on prod or dev. If we're in dev we won't hit the OpenAI endpoint instead we'll hit a mock function that we'll implement. This mock function should mimic an OpenAI call.

If the submission fails at the OpenAI level or the subsequent score extraction level, insert this code, email to the DB.

Create an endpoint for a cron job that will ping our DB periodically to retry failed submissions. If the job fails again, increment the retry count. When the retry count == 3, send an email to one of us with the details of the failed job.

• if user has rated, don't show the rating section by default. We'll provide an obscure button for re-rating
• upon getting to /code-area, the email should be pushed into localStorage. As the user codes, the code should also get pushed into localStorage. This is so that if the user refreshes their page, their progress doesn't get lost. This is due to currently we're using zustand to store these data, which will be cleared if the user refreshes their page.
• building upon the previous point, the validation process for whether the user should be in the /code-area page will need to account for localStorage now. We don't need to get rid of the zustand store and we don't need to modify the validation logic for whether the user should be in the /code-area. We just need to additionally write the email and code to localStorage.
• When the user ends their session, the localStorage should be purged.

• What is Tailspin
• Why Tailspin
• Future plans for Tailspin (Time series step display)
• Authors (link GH)
• Contribute guide
• FAQ (Accordion)
• Limitations of Tailspin, and how we're addressing it

Maybe green to orange as primary color?
And purple as secondary color?

Up for debate

• Using the DB, implement a rate limiter. Rate to be decided.
• Look into captcha

In the code-area

• when the user is viewing the prompt, enlarge the close prompt button. Or somehow make it obvious this is the button to close the prompt section
• when the user is not viewing the prompt, let the prompt button and actions button be the same size (room for ideas here)

• Define a Query Key and make the fetch site counters functionality useQuery. Hint, make the fetching function a "use client". Only client side queries can use React Query.
• Implement useMutation onto the Submit button. onSettled, send an invalidation request using the Query Key defined in the first bullet to refresh the site counters.

• Move more state into DB for persistence

Sanitize

• email
• code (make sure it doesn't have the <script> tag

Implement react-mosaic for Editor and Preview features

1. User should choose difficulty level. Select time or untimed. (For now we'll not implement timed mode but get used to the idea)
2. User should accept TOS and supply an email
3. When data is verified, spawn the sandbox.
4. After submitting the UI should revert back to 1, pop confetti, and BE should handle OpenAI request and email callback.