Jest testing

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.13.0]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v3
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test --if-present

.gitignore

@@ -1,9 +1,8 @@
 config.json
 node_modules/
-package-lock.json
 data/
 local_files/
 mirror.flp
 logs/
 built/
-.prettierrc
+.prettierrc

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Ford Friedel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,13 +1,59 @@
-# Mirror TS
+<img align="left" width="auto" height="90" src="./docs/images/thumbnail128x128.png">
 
-Mirror is an informational Discord bot.
+[![Join us on Discord](https://img.shields.io/discord/938519232155648011.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/uvdg2R5PAU)
 
-Mirror was created by Fordle#0001 and Phantasm#0001
+[![MIT License](https://img.shields.io/badge/license-MIT-informational.svg)](./LICENSE)
+
+
+# About Mirror
+
+Mirror is a multi-purpose Discord bot which provides fun, immersive and informative features for your discord server at no cost.
+
+Mirror is a for fun personal project for learning programming and computer science concepts through TypeScript, GitHub and the Discord API.
+
+Mirror was created by Fordle#0001 and Phantasm#0001, with contributions from our friends.
+
+## Essential Commands
+
+### Introthemes
+
+Set your introtheme with [`/intro`](src/slashcommands/Intro.ts) to play an audio clip everytime you join the chat channel!
+
+Find a 10 second or shorter youtube video and paste the link into 'video' feild.
+
+### Music Player
+
+Mirror allows users to listen to songs and playlists from Spotify, Youtube and Soundcloud.  Using [`/play`](src/slashcommands/Play.ts) or [`/playnext`](src/slashcommands/PlayNext.ts) you can search for songs or paste your own song or playlist and it will add it to the queue.
+
+The Music functionality includes many commands:
+ - [x] [`/shuffle`](src/slashcommands/Shuffle.ts)
+ - [x] [`/loop`](src/slashcommands/Loop.ts)
+ - [x] [`/resume`](src/slashcommands/Resume.ts), [`/pause`](src/slashcommands/Pause.ts)
+ - [x] [`/queue`](src/slashcommands/Queue.ts), [`/clearqueue`](src/slashcommands/ClearQueue.ts)
+ - [x] [`/skip`](src/slashcommands/Skip.ts)
+ and more!
+
+### Informative Commands
+
+ - [x] [`/weather`](src/slashcommands/Weather.ts) Current weather for a provided city.
+
+ - [x] [`/stock`](src/slashcommands/Stock.ts) Daily summaries for up to 10 provided tickers.
+
+ - [x] [`/nasa`](src/slashcommands/Nasa.ts) Display the NASA Astronomy Picture of the Day.
+
+## Contributing to Mirror
 
 Mirror is a public project and as such you are welcome to contribute if you desire.
 
 If you want to work on Mirror with the team reach out to one of us on discord and we will get you started.
 
+For more information on formatting and installing the bot read below: 
+
 [Contributing](docs/CONTRIBUTING.md)  
 [Building the bot](docs/BUILDING.md)  
 [APIs we use](docs/APIDOCUMENTATION.md)
+
+## Aknowledgements
+
+
+

jest.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'node',
+    collectCoverage: false,
+};