Skip to content

Instantly share code, notes, and snippets.

@DjjimmyHD

DjjimmyHD/fullstackReadmeGuide.md

Created December 21, 2018 17:28
Show Gist options
  • Save DjjimmyHD/b9c42ce275dcb0d01752c057811422d3 to your computer and use it in GitHub Desktop.
Save DjjimmyHD/b9c42ce275dcb0d01752c057811422d3 to your computer and use it in GitHub Desktop.
Download ZIP
Fullstack README Requirements
Raw
fullstackReadmeGuide.md

Creating A Clean and Cohesive README.md

Description

The README.md file is a powerful tool that helps you a user implement your project and gives them the jist of what your app does. The following are the minimum requirements expected on all fullstack applications.

Your project should have

  • A brief description of the application itself

    • What the app is for

    • What problem does it hope to solve

    • Who is the app designed for

  • The technologies used

  • Contributors

  • A link to the back-end repo/front-end repo, respectively

  • A link to deployed back-end site && font-end site

  • Install steps

Pro Tip

Attaching screen shots of the working app or a gif of the application running makes it more likely a rectuirer or team lead will actually see what you have created. People care about your ability to create something that works.

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