An open API service indexing awesome lists of open source software.

https://github.com/capstone-projects-2023-spring/hackathon-discordc3po

hackathon-discordc3po created by GitHub Classroom
https://github.com/capstone-projects-2023-spring/hackathon-discordc3po

Last synced: over 1 year ago
JSON representation

hackathon-discordc3po created by GitHub Classroom

Awesome Lists containing this project

README

          

[![Open in Codespaces](https://classroom.github.com/assets/launch-codespace-f4981d0f882b2a3f0472912d15f9806d57e124e0fc890972558857b51b24a6f9.svg)](https://classroom.github.com/open-in-codespaces?assignment_repo_id=9890420)

# Discord C3PO
[![Report Issue on Jira](https://img.shields.io/badge/Report%20Issues-Jira-0052CC?style=flat&logo=jira-software)](https://temple-cis-projects-in-cs.atlassian.net/jira/software/c/projects/DT/issues)
[![Deploy Docs](https://github.com/ApplebaumIan/tu-cis-4398-docs-template/actions/workflows/deploy.yml/badge.svg)](https://github.com/ApplebaumIan/tu-cis-4398-docs-template/actions/workflows/deploy.yml)
[![Documentation Website Link](https://img.shields.io/badge/-Documentation%20Website-brightgreen)](https://applebaumian.github.io/tu-cis-4398-docs-template/)

## Keywords

Section 704, Discord, c3PO, Schedule, Calendar, Bot, Events, Canvas, API, JavaScript

## Project Abstract

This document proposes a novel application of a discord bot to assist with events from a public shared API. The bot will have the following commands; week, next, all, and help which can be reviewed with ! prefix.

## High Level Requirement

The discord bot will pull scheduled events from Prof. Ians API and provide the results to the channel in discord.

## Conceptual Design

The bot would need

## Background

The background will contain a more detailed description of the product and a comparison to existing similar projects/products. A literature search should be conducted and the results listed. Proper citation of sources is required. If there are similar open-source products, you should state whether existing source will be used and to what extent. If there are similar closed-source/proprietary products, you should state how the proposed product will be similar and different.

## Required Resources

The bot will use pythons DateTime library to assist with past due, current, and upcomming events.

Discuss what you need to develop this project. This includes background information you will need to acquire, hardware resources, and software resources. If these are not part of the standard Computer Science Department lab resources, these must be identified early and discussed with the instructor.

## UML Class Diagram

```mermaid
classDiagram
main --> datetime
main --> discord
class datetime{

}
class discord{

}

class main{
+String response
+String megaText
+int eventsFound
+String addtoOutput
+date today
+date todaysCalanderWeek
+date eventsCalenderWeek
}
```

## UML Sequence Diagram
```mermaid
sequenceDiagram
actor User
autonumber
User->>Discord: TypeCommand()
Discord->>Bot: RecievesCommand()
Bot->>Discord: Replies()
Discord->>User: SeesInfo()
```

## Collaborators

[//]: # ( readme: collaborators -start )



ApplebaumIan


Ian Tyler Applebaum




leighflagg


Null

[//]: # ( readme: collaborators -end )