myhelpapp's People
myhelpapp's Issues
Backend Routes
Backend Routes
- Contains the following sections: HTML, API Endpoints(Backend)
- Each route has a description
- API Endpoint routes contains wildcard variables written in
snake_case
- Routes does not contain superfluous routes
- Have API routes that will allow the front end to get all info it needs and does not have unneeded routes:
- probably doesn't need a
GET likes
api endpoint because that info comes through the post show
- probably doesn't need a
Comments
GET /api/reviews
is not necessary because you can get the reviews for a business when you doGET/api/businesses/:id
GET/api/businesses/:reviewId
this looks incorrect. If I want all the reviews for a business, how could I only pass in one review id?GET /api/reviews/:businessId
superfluous
Sample State
Sample State
- State shape is flat!
- State's keys are camelCased
- All keys within the values in the state are accessible in the schema
- Correctly formatted
- Sample state is rendered with triple backticks, and the language
```javascript...```
). This will display the state as a code block instead of a giant line of text - Top level slices
-
entities
-
session
-
errors
(here or inui
) -
ui
(if needed)
-
- Should NOT have nested slices, aka
comments
inside ofposts
- Some info from other tables is ok, for instance:
- the author username and imageurl for a post. basically any info that the user can't change
- like count and a boolean on whether the user likes the post instead of a likes slice
- Some info from other tables is ok, for instance:
- Sample state is rendered with triple backticks, and the language
Comments
- Check the schema comments. You may need some more info in businesses. If a business only has one category, you can just put the category within each business. Happy to talk about this further.
- I would recommend having a reviewIds array within each business in the business slice of state to keep track of all of the related reviews
MVP List
MVP List
- Should have 7 MVPs.
- 3 of those are User Auth, Heroku, and Production README.
- The other 4 are from the 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 MVP
- Correctly formatted
- MVPs are listed in an ordered list
- Each MVP is broken down into bullet points
Comments
Business MVP
- Backend: DB, model, controller, views
- Redux Loop: ajax, actions, reducer
- Presentational Components and Containers
- Styling
- Smooth, bug-free navigation
- Adequate and appropriate seeds
Frontend Routes
Frontend Routes
- Frontend routes contains wildcard variables written in
camelCase
- Correctly formatted
- Routes are displayed with
inline coding text
(backticks)
- Routes are displayed with
Comments
- Same question I had for Alex: what will be the page they see after log in?
User Auth
User Auth
Functionality
- The main button with logo should link to
/
- Has working demo login
- Smooth, bug free navigation
Before Login
- The
/login
page should not display a link toLog In
. Same for/signup
- Going to a random route
/#/oweiniouewbrviuwebv
should redirect or display a 404 page - Errors should display for both
/signup
and/login
. - Errors should clear when moving between
/signup
and/login
. - Can sign up a user
- Can sign in as a user
- Can log out a user
- Can't sign up with the same username/email
- Pressing enter after filling out the session form should use the form data, not the demo user
After Login
- Should not be able to visit
/login
or/signup
- Should be able to refresh the page and still be logged in
Style
- The site should look exactly like the actual site
- All relevant elements should have
cursor: pointer
on hover - When errors are displayed, most elements should not move around the page (particularly input boxes)
- Remove Redux logger and all console.log()'s from production
Seeds
- Adequate and appropriate seeds
Full Checklist
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
Comments
MVP List
- Should have 7 MVPs.
- 3 of those are User Auth, Heroku, and Production README.
- The other 4 are from the 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 MVP
- Correctly formatted
- MVPs are listed in an ordered list
- Each MVP is broken down into bullet points
Comments
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
- foreign key and table name are lowercased, snake_cased and
- 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
Comments
Sample State
- State shape is flat!
- State's keys are camelCased
- All keys within the values in the state are accessible in the schema
- Correctly formatted
- Sample state is rendered with triple backticks, and the language
```javascript...```
). This will display the state as a code block instead of a giant line of text - Top level slices
-
entities
-
session
-
errors
(here or inui
) -
ui
(if needed)
-
- Should NOT have nested slices, aka
comments
inside ofposts
- Some info from other tables is ok, for instance:
- the author username and imageurl for a post. basically any info that the user can't change
- like count and a boolean on whether the user likes the post instead of a likes slice
- Some info from other tables is ok, for instance:
- Sample state is rendered with triple backticks, and the language
Comments
Backend Routes
- Contains the following sections: HTML, API Endpoints(Backend)
- Each route has a description
- API Endpoint routes contains wildcard variables written in
snake_case
- Routes does not contain superfluous routes
- Have API routes that will allow the front end to get all info it needs and does not have unneeded routes:
- probably doesn't need a
GET likes
api endpoint because that info comes through the post show
- probably doesn't need a
Comments
Frontend Routes
- Frontend routes contains wildcard variables written in
camelCase
- Correctly formatted
- Routes are displayed with
inline coding text
(backticks)
- Routes are displayed with
Comments
Schema Checklist
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
- foreign key and table name are lowercased, snake_cased and
- 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
Comments
- Formatting could use some work. Try mimicking the format of Bluebird wiki
- If there is a one-to-many relationship between users and businesses, then businesses should have a
user_id
foreign key
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.