Rachit Final Checkpoint Plan #84
Description
Objective
The objective of this sprint is to finish websockets (which just need the correct APIs and methods) and then to document the websockets and write them in nodejs, python, and java with extensive documentation. As of now, I have been focused and dedicated to making websockets work, especially through Nginx and many other protocols (the amount of stackOverflow reading I had to do for this...). Currently, websockets are not being utilized since multiplayer has not been developed yet, however, as multiplayer develops, websockets will be utilized more and more.
Tasks
- Figure out what API's websockets need
- Write Documentation for websockets
- Complete a demo and documentation for Java Websockets
- Complete a demo and documentation for Python Websockets
- Complete a demo and documentation for Nodejs Websockets
Plan
Requirements
- POSTMAN
- Keyboard
- Research (already completed)
On Codemaxxers
- Get API List
- Program APIs
- Document formatting for APIs
- KEY SPLITTING and logging documentation
Integration is with the feature (that is literally what its for)
On Java Demo
- Simplify CodemaxxerConnections
- Write README
- Copy Nginx Configurations
On Nodejs Demo
- Figure out how to make it not go through localhost (really Mr. Mortensen)
- Create new Nodejs repo
- Deploy a tester for it (try going through vercel first for easier logging)
- Write README
- Write Nginx configurations
On Python Demo
- Learn how to use flask
- Research python websocket stuff
- Make an API for python websockets
- yipeee test it
- Write a README and Nginx configurations
Schedule
Monday
- Ask what multiplayer needs from websockets
- Write documentation for codemaxxer websockets and key splitting
Tuesday
- Create blog/repo for Java.
- Finish Java tasks
- Test Java
Wednesday
- Create blog/repo for Nodejs.
- Finish Nodejs tasks
- Test Nodejs
Thursday
- Flask research day
- Learn how to use and create a flask starter
- Start on python tasks
Friday
- Finish creating blog/repo for Nodejs.
- Finish python tasks
- Test python
- Wrap up everything in a nice blog
According to this plan, everything shall be done and ready to go by Friday.
Milestones
- COMPLETELY WRAP UP CODEMAXXERS (NO ONE SHOULD NEED TO ASK ME FOR WEBSOCKETS I THINK THIS IS ALMOST DONE) Due monday
- Finish Java documentation for websockets due tuesday
- Finish Nodejs documentation for websockets due wednesday
- Finish python documentatiojn for websockets due friday
- Finish blog with everything for presentation due friday
Presentation plan
Stage 1: Codemaxxers
- Present all sum of work in codemaxxers
- Dedicate 7-8% of time to websockets and more to multiplayer
- Live Demo through postman since it may not seem obvious through gameplay (will still demo gameplay)
Stage 2: Explanations
- Talk about design process, successes and failures, thousands of webpages of research (AGAIN SHOUTOUT TO STACKOVERFLOW)
- Describe integration and purpose (not too hard, literally built for integration)
- Describe protocols and structures, from each layer of the web
- Describe the simplified usage and applications
- Show the keyhandler and talk about creating your own websocket interface with own commands.
- Show movement from initial github commits to codemaxxers to more web based testing (since the protocol is simple enough, but every layer, such as nginx, has to wrap it, which is why I may not have too many commits nearing the end)
Stage 3 (part of stage 1): Demo
- Demo websockets with sample commands in keyhandler
- Demo working multiplayer
Stage 4: Wrapup
- Make sure to hit all checkboxes
- Get over 6 hours of sleep
- Archive and preserve project
Documentation and pictures
Documentation should look like this:
Work and analysis should look like this:
Make sure to include all files:
Make sure to have some humor:
