Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation to client README / repo #1

Open
8 of 12 tasks
terichadbourne opened this issue Jul 17, 2018 · 0 comments
Open
8 of 12 tasks

Add documentation to client README / repo #1

terichadbourne opened this issue Jul 17, 2018 · 0 comments
Labels
client required

Comments

@terichadbourne
Copy link
Contributor

terichadbourne commented Jul 17, 2018 •
edited
Loading

Produce documentation on Github:

  • Create 2 Github repos (one for your front-end and one for your back-end)
  • Pin both repositories on GitHub as a Popular Repository

Both front-end and back-end repos should include README's with:

  • Complete the repository Description field and Website field with a meaningful sentence description of the application and link to the live URL github image
  • An explanation of the what the app does and how it works.
  • A link to the other repo
  • A link to both deployed sites
  • List of technologies used
  • List unsolved problems which would be fixed in future iterations.
  • Document your planning, process and problem-solving strategy

Your front-end repo's README should also have:

  • Link to wireframes and user stories

Your back-end repo's README should also have

  • Link to Entity Relationship Diagram (ERD).
  • A catalog of routes (paths and methods) that the API expects.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
client required
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@terichadbourne