search

boyangles / ece-inventory-app

An inventory system to track items for the Duke ECE Department
3 stars 1 forks source link

Development Doc addition --> Swagger-UI submodule under public/swagger #84

Open boyangles opened 7 years ago

boyangles commented 7 years ago

Describe the addition of swagger and how to initialize when first obtaining our repo:

  1. rails swagger:docs --> updates when changes related to swagger
  2. If Swagger-UI submodule doesn't exist in .gitmodules, do this: git submodule add git@github.com:wordnik/swagger-ui.git swagger
  3. If Swagger-UI submodule does exists and is not updated and/or is empty, run this command: git submodule update --init --recursive
rjordanfrazier commented 7 years ago

updated command: git submodule add https://github.com/swagger-api/swagger-ui.git swagger

rjordanfrazier commented 7 years ago

Also make sure you're inside your public directory when running git submodule commands