deutranium / typewriter.mlh

A web-based typing game to help users improve their speed when programming

Hello World 👋

typewriter.mlh's Issues

Create base endpoints for backend

For endpoints we will need:

• Root URL (make sure it's functional)
• GET endpoint for returning random snippet
• GET endpoints for language-specific snippets (for the future)

Also:

• We need to keep in mind how we are going to return this data
  • json that looks like {"snippet": "code goes here"}?
  • Maybe something like {"snippet": ["words", "split", "into", "array"]}?

Gather Code Snippets

We need to:

• Find a source for our code snippets
• Scrape them
• Find out how to store them
  • Local for now, DB later?

Persist Snippets to DB

We will need a Database for persisting our snippets:

• Should likely be NoSQL
  • Mongo, Fauna, DataStax, something along these lines
• Would speed up development if it is cloud hosted
  • Either cloud hosted by the DB provider, or some cloud provider like AWS

Then we have to interface our backend with the DB

Connect front-end and back-end

Need to update state by querying backend endpoint, which is synced with Fauna Database

Integrate Backend with DB

Make use of FaunaDB drivers to integrate the backend with the DB and query for code snippets

Create the frontpage

Make the dashboard, place the buttons for a responsive flow.

Get code snippet based on different languages

Modify the server and database to get snippets based on the prorgamming language

Mockup

Just a basic mockup so that we have something to work off of on the frontend

• Maybe similar to the TypeRacer layout

Add support for other languages

We can create separate endpoints for a small handful of languages on the backend, and then hit a an endpoint from the frontend, conditional on the user's selected language.