Merge pull request #1 from UWLSimulationCentre/documentation

Documentation Update

CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased](https://github.com/UWLSimulationCentre/Codex/compare/...HEAD)
+
+### Added
+- ...
+
+## [Codex 1.0.0](https://github.com/UWLSimulationCentre/Codex/releases/tag/Codex-1.0.0) - 2023-11-26
+
+### Added
+- 🌱 Initial Release
+
+### Changed
+- 🌱 Initial Release

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
+
+Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.

README.md

@@ -1 +1,58 @@
-# Codex
+![](https://i.imgur.com/Hoq8m18.png)
+![](https://img.shields.io/github/contributors/UWLSimulationCentre/Codex) 
+![](https://img.shields.io/github/last-commit/UWLSimulationCentre/Codex) 
+![](https://img.shields.io/github/issues/UWLSimulationCentre/Codex) 
+
+
+# Codex PowerApp Launchpad App
+
+From Latin, *Lorem Codex* translates to ***Launchpad***. This application provides staff within the [Simulation Centres](https://www.uwl.ac.uk/business/university-venue-hire/medical-simulation-centre), an easy-to-use page of useful resources and applications used to conduct day-to-day work.
+
+<div align="center">
+  <kbd>
+    <img src="https://i.imgur.com/89PmKHM.png" />
+  </kbd>
+</div>
+
+## Description
+
+Trying to share resources with staff is often quite challenging. The use of long emails and informational documents creates inequity with people who learn through the use of more modern methods. This application provides an easy-to-use and accessible option for [Simulation Centre](https://www.uwl.ac.uk/business/university-venue-hire/medical-simulation-centre) staff to access important information and resources.
+
+### Features
+
+- Easily Accessible and Navigated
+- Loggable Access and Usage using MS Accounts
+- Single-Paged Launchpad of Links
+- Easily Updateable
+
+### Built with
+
+- MS PowerApps
+
+## Getting started
+
+### Prerequisites
+
+Accessible using browser or through the MS PowerApps application on modern mobile devices.
+
+### Install
+
+Click on [this link](https://apps.powerapps.com/play/e/a334f803-c7e9-e554-9e2e-f8a20c6d36a4/a/5f6fdc80-cbc4-4d14-8647-8740efc3770c?tenantId=b0abd1ed-4966-4274-9f19-59dd663e81f5&hint=3011eaa0-5665-4a04-bc33-48cd8970b901&sourcetime=1701008195688) to access the application directly.
+
+### Usage
+
+Used by [Simulation Centre](https://www.uwl.ac.uk/business/university-venue-hire/medical-simulation-centre) staff to access useful information and guidelines.
+
+## Back matter
+
+### Legal disclaimer
+
+Usage of this tool for attacking targets without prior mutual consent is illegal. It is the end user's responsibility to obey all applicable local and national laws. Developers assume no liability and are not responsible for any misuse or damage caused by this repository.
+
+### Acknowledgements
+
+[@smcnab1](https://github.com/smcnab1) for building application.
+
+### License
+
+This project is licensed under the [MIT License](LICENSE.md).

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+## Reporting a Vulnerability
+
+<!--
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.
+-->
+
+To report a security issue, please email [[email protected]](mailto:[email protected]) with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. This project follows a 90 day disclosure timeline.