topheryun / companionbot

CompanionBot

Description

You are by yourself on a lonely Valentine's Day weekend. We created the perfect app to fulfill your needs. You can converse with CompanionBot and even confess your love!

---

Features

• Configure bot's name and gender
• Ask bot about various interests
• Confess your love to the bot
• Can get rejected by the bot

---

Technologies Used

• Discord.js
• Java / Spring
• CockroachDB

---

Getting Started

1. Copy the repository url from the HTTPS tab by pressing the green clone button, or copy the url and append .git to the end.

2. Clone the repository by opening Git Bash at the desired location and running the clone command:

   • git clone (name-of-url).git

3. Follow this guide to create a Discord bot and add it to your server.

4. Create a config.json file at the root level to contain sensitive data and place it your .gitignore file. It contains:

   • URL which is the server endpoint
   • TOKEN which is your Discord bot's private token
   • CHANNEL if you want to specify which channel your bot is active on.

5. Open Git Bash in the cloned folder and run:

   • node .

---

Usage

User can login to their account, and they can view their account details after inputting an initial balance. In the homepage screen, they can update their income, expenses, and balance. In the second tab, the user can view their projected balance for the following weeks. The user can end their session by pressing the logout button at the top right of the screen.

---

Contributors

• Christopher Yun
• John Magnuson
• Grant Wiswell
• Taylor Lee

Version

• First Iteration: Feb 12, 2021 - Feb 14, 2021