Hi Rohan, here is a checklist for going through your docs. I'll go through what you have so far and leave comments underneath.
Wiki Page Home
[ ] Is the first page you see upon entering the wiki
[ ] Contains a welcome message
[ ] Contains a link/placeholder for a link to the live page
[ ] All links in the right sidebar should contain each wiki page and link to the correct page
[ ] Correctly formatted
[ ] each wiki page is listed in bullet points
[ ] all links route the correct page
Feature List
[ ] Should have 7 Features.
[ ] 3 of those are User Auth, render.io, and Production README.
[ ] The other 4 are from the Feature/MVP List or they have clarified them with you
[ ] Contains a description sentence of the app
[ ] Includes two to three detailed bullets on functionality and presentation of feature
[ ] At least one CRUD feature, which states what CRUD operations are planned (creation, reading, updating, deletion)
[ ] Estimates how long it will take the code each feature
[ ] Correctly formatted
[ ] features are listed in an ordered list
[ ] Each feature is broken down into bullet points
Database Schema
[ ] Contains correct datatypes
[ ] Contains appropriate constraints/details
[ ] primary key
[ ] not null
[ ] unique
[ ] indexed
[ ] foreign key
[ ] Contains bullet points after the table that state which foreign keys will reference to which table, or references to the associations which will be made
[ ] foreign key and table name are lowercased, snake_cased and back_ticked
[ ] Correctly formatted
[ ] schema is written in a table format
[ ] the table's name are lowercased, snake_cased and back_ticked
[ ] the table header column names are bolded
[ ] columns names are lowercased and snaked_cased and back_ticked
Hi Rohan, I have some notes on your design docs so far:
Feature List:
Part of the description talks about bluebird.
It currently looks like you don't have a plan for implementing live chess (or shogi). If you would like to include it, I'd be happy to meet with you to talk about how it could be done.
Otherwise, the feature list looks good.
Schema:
Users looks good 👍
For the games, I imagine that the body is just a list of moves? If so, that is good.
One thing you'll want to think about with the friends table, is how you plan on implementing friend requests. When a request goes through, there is a period where the person being requested has not accepted the request yet, and you'll need a column to represent that. A boolean 'accepted' column could achieve that.
That's all for now, let me know if you have questions!
Hi Rohan, here is a checklist for going through your docs. I'll go through what you have so far and leave comments underneath.
Wiki Page Home
Feature List
Database Schema
back_ticked
back_ticked
back_ticked