Design Docs

[siascone]

Wiki Page Home

• [x] Is the first page you see upon entering the wiki
• [x] Contains a welcome message
• [x] Contains a link/placeholder for a link to the live page
• [x] All links in the right sidebar should contain each wiki page and link to the correct page
• [x] Correctly formatted
  • [x] each wiki page is listed in bullet points
  • [x] all links route the correct page

---

MVP List

• [x] Should have 7 MVPs.
  • [x] 3 of those are User Auth, Heroku, and Production README.
  • [x] The other 4 are from the MVP List or they have clarified them with you
• [ ] Contains a description sentence of the app
• [x] Includes two to three detailed bullets on functionality and presentation of feature
• [x] At least one CRUD feature, which states what CRUD operations are planned (creation, reading, updating, deletion)
• [x] Estimates how long it will take the code each MVP
• [x] Correctly formatted
  • [x] MVPs are listed in an ordered list
  • [x] Each MVP is broken down into bullet points

---

Database Schema

• [x] Contains correct datatypes
• [x] Contains appropriate constraints/details
  • [x] primary key
  • [x] not null
  • [x] unique
  • [x] indexed
  • [x] foreign key
• [x] 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
  • [x] foreign key and table name are lowercased, snake_cased and back_ticked
• [x] Correctly formatted
  • [x] schema is written in a table format
  • [x] the table's name are lowercased, snake_cased and back_ticked
  • [x] the table header column names are bolded
  • [x] columns names are lowercased and snaked_cased and back_ticked

---

Sample State

• [x] State shape is flat!
• [x] State's keys are camelCased
• [x] All keys within the values in the state are accessible in the schema
• [x] Correctly formatted
  • [x] 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
  • [x] Top level slices
    • [x] entities
    • [x] session
    • [x] errors (here or in ui)
    • [x] ui (if needed)
  • [x] Should NOT have nested slices, aka comments inside of posts
    • 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

---

Backend Routes

• [x] Contains the following sections: HTML, API Endpoints(Backend)
• [x] Each route has a description
• [x] API Endpoint routes contains wildcard variables written in snake_case
• [x] 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

---

Frontend Routes

• [x] Frontend routes contains wildcard variables written in camelCase
• [x] Correctly formatted
  • [x] Routes are displayed with inline coding text (backticks)

[siascone]

Above is a list of guide lines you can follow to complete each design docs.

Here is a markdown language cheetsheet

Here is a markdown table generator

I will follow this comment with example markdown for each page and you can fill out/expand on the rest

[siascone]

Wiki Home page

Welcome to the bluebird wiki!

# Bluebird Design Documents

[Bluebird Live]()

+ [MVP list](mvp-list)
+ [Schema](schema)
+ [Sample State](sample-state)
+ [Frontend routes and components](frontend-routes)
+ [Backend routes](backend-routes)

[siascone]

MVP List

Example of MVPs 1, 2, and 7. Everyone will have these, you should add in your four features as MVPs 3, 4, 5, and 6.

### 1. Hosting on Heroku (04/03/2018)

### 2. New account creation, login, and guest/demo login (04/04/2018, 2 days)
  + Users can sign up, sign in, log out
  + Users can use a demo login to try the site
  + Users can't use certain features without logging in (creating chirps & likes)

### 7. Production README (04/13/2018, 0.5 days)

[siascone]

Schema

Here is an example of a users table. You should make the rest of the tables you need with relevant column names, data types, details and bullets

# Postgres Database Schema

## `users`
| column name       | data type | details                   |
|:------------------|:---------:|:--------------------------|
| `id`              | integer   | not null, primary key     |
| `username`        | string    | not null, indexed, unique |
| `email`           | string    | not null, indexed, unique |         
| `password_digest` | string    | not null                  |
| `session_token`   | string    | not null, indexed, unique |
| `created_at`      | datetime  | not null                  |
| `updated_at`      | datetime  | not null                  |

+ index on `username, unique: true`
+ index on `email, unique: true`
+ index on `session_token, unique: true`
+ `has_many chirps`
+ `has_many likes`

[siascone]

Sample State

Example sample state

```js
{
  entities: {
    chirps: {
      1: {
        id: 1,
        body: "bluebirds like blueberries",
        authorId: 11,
      },
      2: {
        id: 2,
        body: "bluebirds also like blue potatoes",
        authorId: 25,
      },
      3: {
        id: 3,
        body: "bluebirds are more like fruit",
        authorId: 11,
      }
    },
    users: {
      11: {
        id: 11,
        username: "blue_macaw",       
      },
      25: {
        id: 25,
        username: "blue_toucan",
        imgUrl: "https://cdn.pixabay.com/photo/2015/10/01/16/43/toucan-967334_960_720.jpg"
      }
    },
    likes: {
        1: {
           id: 1, 
           userId: 2,
           chirpId: 1
        }
    }
  },
  ui: {
    loading: true/false,
    modal: true/false
  },
  errors: {
    login: ["Incorrect username/password combination"],
    chirpForm: ["Chirp body cannot be blank"],
  },
  session: { currentUserId: 25 }
}

[siascone]

Frontend Routes

Example frontend routes

## Frontend Routes
+ `/`
  + `Splash`
+ `/login`
  + `SessionForm`
+ `/signup`
  + `SessionForm`
+ `/feed`
  + `ChirpIndex`
    + `ChirpIndexItem`
+ `/users/:userId`
  + `ProfileComponent`
  + `ChirpIndex`
    + `ChirpIndexItem`
+ `/chirps/new`
  + `ChirpForm`
+ `/chirps/:chirpId`
  + `ChirpShow`
+ `/chirps/:chirpId/edit`
  + `ChirpForm`

[siascone]

Backend Routes

Example backend routes

# Backend Routes

## HTML

+ `GET /` - `StaticPagesController#root`

## API Endpoints

### `users`
+ `GET /api/users` - returns the user information of displayed chirps and for the User Search feature
+ `POST /api/users` - sign up

### `session`
+ `POST /api/session` - log in
+ `DELETE /api/session` - log out

### `chirps`
+ `GET /api/chirps` - returns relevant chirps (filtered by `data`/`params`)
+ `GET /api/chirps/:id` - returns chirp
+ `POST /api/chirps` - creates a chirp
+ `PATCH /api/chirps/:id` - edit a chirp
+ `DELETE /api/chirps/:id` - remove a chirp

### `likes`
+ `POST /api/likes` - like a chirp
+ `DELETE /api/likes/:id` - unlike a chirp

Note: likes does not include a `GET` route because we will have these routes render the `api/chirps/show.json.jbuilder` view. See [Sample State](sample-state). 

[siascone]

updates to make

MVP List

• missing description sentence of app
• MVPs 3, 4, 5, and 6 should be the following
  • 3) Posts
  • 4) Feed
  • 5) Follows
  • 6) Likes
• add estimated dates for completion on each MVP

Schema

• need tables for follows, and likes.
• no need for reposts now. Also reposts can just be special posts so no need for a reposts table
• comments can say but is likely a bonus feature

Sample State

• Needs to be updated with tumblr data

Backend Routes

• comments can stay but is likely a bonus feature

Frontend Routes

• user/:userId route for profile may be bonus. Focus on posts, feed, follows and likes first. Can add profile after those
• wildcards should be camelCased not PascalCased. Change /posts/:PostId to /posts/:postId

[siascone]

These docs are looking really good. Below are the final updates. Let me know when you have these complete.

MVP List

• missing description sentence of app

Backend Routes

• comments
  • comment DELETE route is to likes, update to comments
  • add an edit route for comments PATCH /api/comments/:id