-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
140 lines (105 loc) · 16.6 KB
/
index.html
File metadata and controls
140 lines (105 loc) · 16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home | Home</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-jsdoc.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/tui-doc.css">
</head>
<body>
<nav class="lnb" id="lnb">
<div class="logo" style="width: 100px; height: 100px">
<a href="https://github.com/Project-Skill-Tree/Skill-Tree-Discord-Bot" rel="noopener noreferrer" target="_blank">
<img src="https://cdn.discordapp.com/attachments/939508059758288939/979289803239608360/FinalLogoAlt2.png" width="100%" height="100%">
</a>
</div>
<div class="title">
<h1><a href="index.html" class="link">Home</a></h1>
</div>
<div class="search-container" id="search-container">
<input type="text" placeholder="Search">
<ul></ul>
</div>
<div class="lnb-api hidden"><h3>Modules</h3><ul><li><a href="module-APIHelper.html">APIHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:APIHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-APIHelper.html#.cancel">cancel</a></li><li><a href="module-APIHelper.html#.deleteTask">deleteTask</a></li><li><a href="module-APIHelper.html#.getAllInList">getAllInList</a></li><li><a href="module-APIHelper.html#.getAvailable">getAvailable</a></li><li><a href="module-APIHelper.html#.getCurrentTasks">getCurrentTasks</a></li><li><a href="module-APIHelper.html#.getInProgress">getInProgress</a></li><li><a href="module-APIHelper.html#.getRecentTasks">getRecentTasks</a></li><li><a href="module-APIHelper.html#.revert">revert</a></li><li><a href="module-APIHelper.html#.skip">skip</a></li><li><a href="module-APIHelper.html#.start">start</a></li><li><a href="module-APIHelper.html#.updateTask">updateTask</a></li><li><a href="module-APIHelper.html#~getAPIKey">getAPIKey</a></li></ul></div></li><li><a href="module-badge.html">badge</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:badge_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-badge.html#.drawBadge">drawBadge</a></li><li><a href="module-badge.html#.getBadgeIcon">getBadgeIcon</a></li></ul></div></li><li><a href="module-createSwipePanel.html">createSwipePanel</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:createSwipePanel_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-createSwipePanel.html#.createLargeMultiActionSwipePanel">createLargeMultiActionSwipePanel</a></li><li><a href="module-createSwipePanel.html#.createLargeSwipePanel">createLargeSwipePanel</a></li><li><a href="module-createSwipePanel.html#.createYesNoPanel">createYesNoPanel</a></li></ul></div></li><li><a href="module-frequencyFormatter.html">frequencyFormatter</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:frequencyFormatter_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-frequencyFormatter.html#.dayToDate">dayToDate</a></li><li><a href="module-frequencyFormatter.html#.formatFrequency">formatFrequency</a></li><li><a href="module-frequencyFormatter.html#.getAbsDate">getAbsDate</a></li><li><a href="module-frequencyFormatter.html#.getDaysBetweenDates">getDaysBetweenDates</a></li></ul></div></li><li><a href="module-ProfileRenderer.html">ProfileRenderer</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:ProfileRenderer_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-ProfileRenderer.html#.displayLevelUp">displayLevelUp</a></li><li><a href="module-ProfileRenderer.html#.displayProfile">displayProfile</a></li><li><a href="module-ProfileRenderer.html#.getProfileImage">getProfileImage</a></li><li><a href="module-ProfileRenderer.html#~drawProfile">drawProfile</a></li><li><a href="module-ProfileRenderer.html#~drawProfileInfo">drawProfileInfo</a></li><li><a href="module-ProfileRenderer.html#~drawXP">drawXP</a></li><li><a href="module-ProfileRenderer.html#~getLevelUpProfileImage">getLevelUpProfileImage</a></li></ul></div></li><li><a href="module-romanNumeralHelper.html">romanNumeralHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:romanNumeralHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-romanNumeralHelper.html#.romanise">romanise</a></li></ul></div></li><li><a href="module-UIHelper.html">UIHelper</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:UIHelper_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-UIHelper.html#.addGlow">addGlow</a></li><li><a href="module-UIHelper.html#.codeBlock">codeBlock</a></li><li><a href="module-UIHelper.html#.fillRoundRect">fillRoundRect</a></li><li><a href="module-UIHelper.html#.imageToBuffer">imageToBuffer</a></li><li><a href="module-UIHelper.html#.splitToN">splitToN</a></li><li><a href="module-UIHelper.html#.strokeRoundRect">strokeRoundRect</a></li><li><a href="module-UIHelper.html#.tint">tint</a></li></ul></div></li><li><a href="module-WeeklyReviewRenderer.html">WeeklyReviewRenderer</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:WeeklyReviewRenderer_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-WeeklyReviewRenderer.html#.displayReview">displayReview</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawHeaderFooter">drawHeaderFooter</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawTasks">drawTasks</a></li><li><a href="module-WeeklyReviewRenderer.html#~drawXP">drawXP</a></li><li><a href="module-WeeklyReviewRenderer.html#~getWeeklyReview">getWeeklyReview</a></li></ul></div></li><li><a href="module-XPHandler.html">XPHandler</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="module:XPHandler_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="module-XPHandler.html#.calcLevelFromXP">calcLevelFromXP</a></li><li><a href="module-XPHandler.html#.calcXPFromLevel">calcXPFromLevel</a></li><li><a href="module-XPHandler.html#.calcXPToLevelUp">calcXPToLevelUp</a></li><li><a href="module-XPHandler.html#.getCharacter">getCharacter</a></li><li><a href="module-XPHandler.html#.getColor">getColor</a></li><li><a href="module-XPHandler.html#.getRank">getRank</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Classes</h3><ul><li><a href="Challenge.html">Challenge</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Challenge_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Challenge.html#.create">create</a></li><li><a href="Challenge.html#update">update</a></li></ul></div></li><li><a href="Item.html">Item</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Item_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Item.html#.create">create</a></li><li><a href="Item.html#toLine">toLine</a></li><li><a href="Item.html#toString">toString</a></li><li><a href="Item.html#update">update</a></li></ul></div></li><li><a href="ListPage.html">ListPage</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="ListPage_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="ListPage.html#update">update</a></li></ul></div></li><li><a href="Page.html">Page</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Page_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Page.html#update">update</a></li></ul></div></li><li><a href="Rank.html">Rank</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Rank_sub"></div></li><li><a href="Setting.html">Setting</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Setting_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Setting.html#start">start</a></li></ul></div></li><li><a href="Skill.html">Skill</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Skill_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Skill.html#.create">create</a></li><li><a href="Skill.html#update">update</a></li></ul></div></li><li><a href="Task.html">Task</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Task_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Task.html#.create">create</a></li><li><a href="Task.html#isChecked">isChecked</a></li><li><a href="Task.html#percentChecked">percentChecked</a></li><li><a href="Task.html#setChecked">setChecked</a></li></ul></div></li><li><a href="Unlocked.html">Unlocked</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Unlocked_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="Unlocked.html#update">update</a></li></ul></div></li><li><a href="User.html">User</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="User_sub"><div class="member-type">Methods</div><ul class="inner"><li><a href="User.html#.create">create</a></li></ul></div></li></ul></div><div class="lnb-api hidden"><h3>Interfaces</h3><ul><li><a href="Swipeable.html">Swipeable</a><button type="button" class="hidden toggle-subnav btn btn-link"> <span class="glyphicon glyphicon-plus"></span></button><div class="hidden" id="Swipeable_sub"></div></li></ul></div><div class="lnb-api hidden"><h3>Global</h3><ul><li><a href="global.html#addXP">addXP</a></li><li><a href="global.html#authUser">authUser</a></li><li><a href="global.html#createUser">createUser</a></li><li><a href="global.html#deleteUser">deleteUser</a></li><li><a href="global.html#getAPIKey">getAPIKey</a></li><li><a href="global.html#getSettings">getSettings</a></li><li><a href="global.html#getUser">getUser</a></li><li><a href="global.html#getUsers">getUsers</a></li><li><a href="global.html#getUsersInTimezone">getUsersInTimezone</a></li><li><a href="global.html#permlevel">permlevel</a></li><li><a href="global.html#saveProfile">saveProfile</a></li><li><a href="global.html#toProperCase">toProperCase</a></li><li><a href="global.html#updateTimezone">updateTimezone</a></li><li><a href="global.html#updateUser">updateUser</a></li><li><a href="global.html#updateXPHistory">updateXPHistory</a></li></ul></div>
</nav>
<div id="resizer"></div>
<div class="main" id="main">
<section>
<article class="readme"><h1>Skill-Tree-Discord-Bot</h1>
<p>The Skill Tree Discord Bot allows users to keep track of their self-improvement progress effortlessly through Discord.</p>
<p><a href="https://discord.gg/skilltree"><img src="https://badgen.net/badge/icon/discord?icon=discord&label" alt="Discord"></a>
<img src="https://badgen.net/github/license/Project-Skill-Tree/Skill-Tree-Discord-Bot" alt="GitHub commits">
<a href="https://github.com/Project-Skill-Tree/Skill-Tree-Discord-Bot/stargazers"><img src="https://badgen.net/github/stars/Project-Skill-Tree/Skill-Tree-Discord-Bot" alt="GitHub commits"></a></p>
<h2>Tech</h2>
<ul>
<li><a href="https://discord.js.org/#/">DiscordJS</a> NodeJS module to interact with Discord's Data</li>
<li><a href="https://nodejs.org/en/">Node.js</a> JavaScript runtime</li>
<li><a href="https://www.npmjs.com/">NPM</a> Package manager for Node.js</li>
<li><a href="https://github.com/AnIdiotsGuide/guidebot/">guidebot</a> Boilerplate example Discord bot</li>
<li><a href="https://mongoosejs.com/">Mongoose.js</a> An Object Data Modeling (ODM) library for MongoDB and Node.js</li>
</ul>
<h2>Requirements</h2>
<ul>
<li><code>git</code> command line (<a href="https://git-scm.com/download/win">Windows</a> | <a href="https://git-scm.com/download/linux">Linux</a> | <a href="https://git-scm.com/download/mac">MacOS</a>) installed</li>
<li><code>node</code> <a href="https://nodejs.org">Version 16.x</a></li>
<li>The node-gyp build tools. This is a pre-requisite for Enmap, but also for a <strong>lot</strong> of other modules. See <a href="https://enmap.evie.dev/install#pre-requisites">The Enmap Guide</a> for details and requirements for your OS. Just follow what's in the tabbed block only, then come back here!</li>
</ul>
<p>You also need your bot's token. This is obtained by creating an application
at <a href="https://discord.com/developers/applications">the Discord developer section</a>. Check the <a href="https://anidiots.guide/getting-started/getting-started-long-version">first section of this page</a>
for more info.</p>
<h2>Installation</h2>
<p>Create a folder within your projects directory and run the following inside it:</p>
<p><code>git clone https://github.com/Project-Skill-Tree/Skill-Tree-Discord-Bot.git</code></p>
<p>Once finished:</p>
<ul>
<li>In the folder from where you ran the git command, run <code>npm install</code>, which will install the required packages.</li>
<li>Make sure you're using node.js <code>v16.14.2</code></li>
<li>Rename <code>.env-example</code> to <code>.env</code> and put each key inside as follows
<ul>
<li>DISCORD_TOKEN - Your bot token</li>
<li>OWNER - Your discord ID</li>
<li>API_URL - The URL of your API instance (for example: http://localhost:3000/v1, must include /v1/ at the end)</li>
<li>API_KEY - The API key (Can be anything, shared between bot and API)</li>
<li>GOOGLE_API_KEY - Google maps API key</li>
</ul>
</li>
<li>Set up the <a href="https://github.com/Project-Skill-Tree/Skill-Tree-API">API</a></li>
<li>Set up the <a href="https://github.com/Project-Skill-Tree/Skill-Tree-Editor">editor</a></li>
</ul>
<h2>Starting the bot</h2>
<p>To start the bot, in the command prompt, run the following command:
<code>node index.js</code></p>
<h2>Contributing</h2>
<p>Read up on <a href="https://docs.github.com/en/get-started/quickstart/github-flow">GitHub flow</a> for instructions on code contribution.
Read the <a href="https://www.projectskilltree.com">documentation wiki</a></p>
<h3>Setting up a development environment</h3>
<p>Read <a href="#installation">Installation</a> to get started.</p>
<p>This project uses Eslint for code formatting. Install it <a href="https://eslint.org/">here</a> and run it before making a pull request with your changes.<br>
You can run Eslint via <code>npx eslint --fix .</code>.</p></article>
</section>
</div>
<footer>
<img class="logo" src="https://cdn.discordapp.com/attachments/939508059758288939/979289803239608360/FinalLogoAlt2.png" style="width: 100px; height: 100px">
<div class="footer-text">NHN Entertainment. Frontend Development Lab</div>
</footer>
<script>prettyPrint();</script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/tui-doc.js"></script>
<script src="scripts/linenumber.js"></script>
<script>
var id = 'package:undefined_sub'.replace(/"/g, '_');
var selectedApi = document.getElementById(id); // do not use jquery selector
var $selectedApi = $(selectedApi);
$selectedApi.removeClass('hidden');
$selectedApi.parent().find('.glyphicon').removeClass('glyphicon-plus').addClass('glyphicon-minus');
showLnbApi();
</script>
</body>
</html>