kcsoc · Soneji · Jan 10, 2021 · Jan 10, 2021 · Jan 10, 2021
diff --git a/.github/workflows/toc.yml b/.github/workflows/toc.yml
@@ -0,0 +1,17 @@
+on:
+  push:
+    paths: ["README.md"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+      - run: |
+          curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
+          chmod a+x gh-md-toc
+          ./gh-md-toc --insert --no-backup README.md
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Auto update markdown TOC
diff --git a/.gitignore b/.gitignore
@@ -23,4 +23,6 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 .eslintrc.json
-.prettierrc
+.prettierrc
+
+gh-md-toc
diff --git a/README.md b/README.md
@@ -1,27 +1,78 @@
+# Introduction to the README Template
+
+Hare Krishna! Welcome to the PS README template. Please fill out this template on how your project is/was developed and deployed to create documentation. The storage of information in one place is very useful and also ensures all the information is present for the future.
+
+Please keep this template structure and do not remove any sections. Feel free to add subsections under the existing headings. If any sections do not apply, please leave them intact, for future use. Do not hesitate to contact the current maintainer (<dhaval@soneji.xyz>) if you have any questions or queries. Please also feel free to submit a Pull Request to improve this template.
+
+This template should be used to create the `README.md` file in your project repository. The file properly starts below! ⬇️
+
 <img src="https://imgur.com/dziDzkS.png" alt="KCSOC Studio Logo" width="400px" />
 
-## Introduction
-Welcome to the official repository for KCSOC Studio.
+# KCSoc Studio
+
+Live site at: studio.kcsoc.com
+
+# Table of Contents 📚
+
+<!--ts-->
+   * [Introduction to the README Template](#introduction-to-the-readme-template)
+   * [KCSoc Studio](#kcsoc-studio)
+   * [Table of Contents <g-emoji class="g-emoji" alias="books" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png">📚</g-emoji>](#table-of-contents-)
+   * [Description and Purpose <g-emoji class="g-emoji" alias="memo" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png">📝</g-emoji>](#description-and-purpose-)
+      * [Screenshots](#screenshots)
+   * [Intended Audience <g-emoji class="g-emoji" alias="performing_arts" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png">🎭</g-emoji>](#intended-audience-)
+   * [People of Contact <g-emoji class="g-emoji" alias="bust_in_silhouette" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f464.png">👤</g-emoji>](#people-of-contact-)
+   * [Technologies, Dependencies, and Notable Libraries <g-emoji class="g-emoji" alias="space_invader" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png">👾</g-emoji>](#technologies-dependencies-and-notable-libraries-)
+   * [How to Run Project <g-emoji class="g-emoji" alias="runner" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png">🏃</g-emoji>](#how-to-run-project-)
+      * [Building from source](#building-from-source)
+         * [npm start](#npm-start)
+         * [npm run build](#npm-run-build)
+   * [Admin Credentials <g-emoji class="g-emoji" alias="business_suit_levitating" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f574.png">🕴</g-emoji>](#admin-credentials-)
+   * [Email for Project <g-emoji class="g-emoji" alias="e-mail" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png">📧</g-emoji>](#email-for-project-)
+   * [Deployment &amp; Costs <g-emoji class="g-emoji" alias="moneybag" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png">💰</g-emoji>](#deployment--costs-)
+   * [Backups <g-emoji class="g-emoji" alias="fire_extinguisher" fallback-src="https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png">🧯</g-emoji>](#backups-)
+
+<!-- Added by: runner, at: Sun Jan 10 22:53:39 UTC 2021 -->
+
+<!--te-->
+
+# Description and Purpose 📝
 
 This revolutionary tool will help you make professional, high-quality posters and trailers for your local KCSOC without you needing to have any photo/video editing skills whatsover! New features are planned to be added soon. Feel free to report any bugs/issues or create pull requests.
 
+## Screenshots
+
+| Landing                            | Image Search                       | Final Creation.                    |
+| ---------------------------------- | ---------------------------------- | ---------------------------------- |
+| ![](https://imgur.com/QZkXRLQ.png) | ![](https://imgur.com/3JjZhy3.png) | ![](https://imgur.com/G76OeSp.png) |
+
+# Intended Audience 🎭
+
+Please describe who your intended audience is here
+
+# People of Contact 👤
+
+Please fill in this table and add any other important people who may need to be contacted in the future.
+
+| Title                 | Name                       | Email             | Phone       |
+| --------------------- | -------------------------- | ----------------- | ----------- |
+| Project Owner/Creator | Hersh Kataria (@hersh-kat) | -                 | -           |
+| Server setup/hosting  | Dhaval (@soneji)           | dhaval@soneji.xyz | 07737312647 |
+| Managed/maintained by | Josh Guha (@joshguha)      | -                 | -           |
+| Emergency Contact     | Firstname Lastname         | email@example.com | 0123456789  |
+
+# Technologies, Dependencies, and Notable Libraries 👾
+
 This project was built using **ReactJS** & **Material-UI**, and uses the following API's:
 
 - **Dropbox API** to get design files when creating posters using a tempalte
 - **Pexels API** to get video clips when creating trailers
 - **Pixabay API** to search for images when creating posters
 - **Shotstack API** to edit and render videos
 
-## Website Link
-Check out the live version of KCSOC Studio at:
+<!-- @joshguha Please add auth information -->
 
-https://kcsocstudio.hershkat.com 
-
-## Screenshots
-
-| Landing                              | Image Search                         | Final Creation.                      |
-| ------------------------------------ | ------------------------------------ | ------------------------------------ |
-| ![](https://imgur.com/QZkXRLQ.png) | ![](https://imgur.com/3JjZhy3.png) | ![](https://imgur.com/G76OeSp.png) |
+# How to Run Project 🏃
 
 ## Building from source
 
@@ -39,3 +90,32 @@ You will also see any lint errors in the console.
 
 Builds the app for production to the `build` folder.<br />
 It correctly bundles React in production mode and optimizes the build for the best performance.
+
+# Admin Credentials 🕴
+
+Please provide any admin credentials for the project here, including credentials for external providers (e.g. google cloud or mongodb)
+
+Main App Login:
+
+```
+Username: admin
+Password: admin
+```
+
+# Email for Project 📧
+
+N/A
+
+# Deployment & Costs 💰
+
+Please provide any costs for APIs, services, etc. here.
+
+| Technology            | Cost |
+| --------------------- | ---- |
+| PS Server for hosting | \_   |
+| Emails                | \_   |
+| Any cloud Solutions   | \_   |
+
+# Backups 🧯
+
+Please provide information on how any data the project stores is being backed up, or add details requesting certain parts of the project to be backed up