Skip to content

Documentation#624

Open
rmfortes wants to merge 5 commits into
developfrom
documentation
Open

Documentation#624
rmfortes wants to merge 5 commits into
developfrom
documentation

Conversation

@rmfortes
Copy link
Copy Markdown
Contributor

  • Related Issue (include '#'): Not associated with an issue number.

  • Description of changes made: Added detailed documentation to README.md reflect the front-end and back-end contributions of SEI36, and provided recommended next steps for future contributors.

@clarknoah @rc1336

Copy link
Copy Markdown
Contributor

@mrrogercampbell mrrogercampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the comments below. I did not mark all of them

Comment thread client/README.md Outdated

Step One: When under 1000px, password requirements box stays the same size - but the input fields change size, are no longer lined up, and are not centered. The text input boxes need to remain the same size, or be centered upon screen resolution shrink.

![Screenshot](Screenshot.jpg)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It doesn't seem like this image is working properly. Take another look for me please.

Comment thread client/README.md Outdated

## URL Route

"/community/view-group"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put this in a backtick quote, so it looks like this:
/community/view-group

Comment thread client/README.md Outdated

## URL Route

"/forum-page"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put this in a backtick quote, so it looks like this:
/forum-page

Comment thread client/README.md Outdated

## URL Route

"/forum-page-hashtag"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put this in a backtick quote, so it looks like this:
/forum-page-hashtag

Comment thread client/README.md Outdated

## URL Route

"/forum-page-topic"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please put this in a backtick quote, so it looks like this:
/forum-page-topic

Comment thread client/README.md Outdated
Comment on lines +479 to +484
```
{
title: "yourtitle",
description: "a description"
}
```
Copy link
Copy Markdown
Contributor

@mrrogercampbell mrrogercampbell May 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add js to the beginning three back quotes, so it looks like this:

{
"title": "yourtitle",
"description": "a description"
}

Comment thread client/README.md Outdated
## Request Example

HTTP Methods: GET, UPDATE, DELETE
`` fetch(`${BASE_URL}/groups/<int:pk>`, { headers: { Authorization: `Token ${localStorage.getItem("token")}` } }) ``
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix this one also.

Copy link
Copy Markdown
Contributor

@mrrogercampbell mrrogercampbell May 22, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

 fetch(`${BASE_URL}/groups/<int:pk>`, { 
   headers: { 
       Authorization: `Token ${localStorage.getItem("token")}` 
     } 
}) 

Comment thread client/README.md
HTTP Methods: GET, UPDATE, DELETE
`` fetch(`${BASE_URL}/groups/<int:pk>`, { headers: { Authorization: `Token ${localStorage.getItem("token")}` } }) ``
if UPDATE request body should include an object with the name of the field, you want to update set to its new value ex. `{title: "King of England"}`

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this one.

Comment thread client/README.md Outdated
## Request Example

HTTP Methods: POST, GET
`` fetch(`${BASE_URL}/media`, { headers: { Authorization: `Token ${localStorage.getItem("token")}` } }) ``
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this.

Comment thread client/README.md Outdated
HTTP Methods: POST, GET
`` fetch(`${BASE_URL}/media`, { headers: { Authorization: `Token ${localStorage.getItem("token")}` } }) ``
If a post request, expects the following request body format
`{ time: Date, image: Image, title: "yourtitle", description: "a description", optionally, the request can include author: Foreign Key of accounts.Profile, hashtag: Foreign Key of community.Hashtag, group: Foreign Key of community.Group, }`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this one.

Copy link
Copy Markdown
Contributor

@mrrogercampbell mrrogercampbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@skut21x-ga Please see the comment below.

Comment thread client/README.md
Comment on lines +631 to +635
{
"author": Foreign Key of accounts.Profile,
"hashtag": Foreign Key of community.Hashtag,
"group": Foreign Key of community.Group
}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to either place Foreign Key of accounts.Profile, in quotes or provide a sample value that goes there and then have a legend below that explains what to pass in.

Example:

{
  "author": "<Foreign Key of accounts.Profile>",
"hashtag": "<Foreign Key of community.Hashtag>",
"group": "<Foreign Key of community.Group>"
}

or
Example:

{
  "author": "1",
"hashtag": "3",
"group": "15"
}
Field Name Value
author Foreign Key of accounts.Profile
hashtag Foreign Key of community.Hashtag
group Foreign Key of community.Group

Comment thread client/README.md

- Deployed on Netlify: https://cotripper.netlify.com/

#### Seeding Heroku
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should use Django fixtures

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants