Skip to content

Instantly share code, notes, and snippets.

@Piglacquer

Piglacquer/BE_repository_guidelines.md

Last active December 12, 2018 17:27
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Piglacquer/e46d828f89a0c58ab431bf76d6060089 to your computer and use it in GitHub Desktop.
Save Piglacquer/e46d828f89a0c58ab431bf76d6060089 to your computer and use it in GitHub Desktop.
Download ZIP
Guidelines for what a back-end repository should include at gschool
Raw
BE_repository_guidelines.md

Requirements for Back-end

Repository

  • No outer containing folder

  • Contains a .gitignore

  • Does not contain node_modules or a DS_STORE file

  • Contains a README.md

  • License

Readme

  • Project description

  • Front-end repository link

  • Front-end deployed link

  • Back-end deployed link

  • Install steps

  • Tech used

Application

Package.json

  • Package.json has a start script

  • Package.json has the correct main file listed

Project

  • Variables are const or let

  • Main file is called 'app.js' or 'index.js'

  • Consistent spacing

  • Consistent semicolon usage

  • Consistent ES5 or ES6 syntax

  • Deployed

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