Refactoring collections handler

This commit is contained in:
th3r00t
2023-03-20 12:12:55 -04:00
parent 11c0c89624
commit 3e89273cbc
10 changed files with 289 additions and 49 deletions

View File

@@ -0,0 +1,42 @@
<!DOCTYPE html>
<html>
<head>
<link rel="Stylesheet" type="text/css" href="style.css">
<link rel="alternate" type="application/rss+xml" title="RSS" href="rss.xml">
<title>Automated Collections</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<div id="Automated Collection Management System"><h1 id="Automated Collection Management System" class="header"><a href="#Automated Collection Management System">Automated Collection Management System</a></h1></div>
<p>
The collection management system needs rewritten from the ground up.
The model should look something like this.
</p>
<ul>
<li class="done0">
<span class="todo">TODO</span> :: Refactor collections algorithm. #8f46262c
<pre python>
Collection {
id: int
name: String
books: list(Book)
}
</pre>
</ul>
<p>
it is likely the book object will need rewritten as well.
</p>
<pre python>
Book {
id: int
title: String
# other book metadata
collection: list(Collection.id)
}
</pre>
</body>
</html>

View File

@@ -29,25 +29,25 @@ sub-folders in your collection.
<div id="Book Scraping System-Scrapers"><h2 id="Scrapers" class="header"><a href="#Book Scraping System-Scrapers">Scrapers</a></h2></div>
<ul>
<li class="done4">
epub #75f00edf
epub #2899a8e9
<li class="done4">
mobi #2fe4b161
mobi #ec035720
<li class="done4">
pdf #ffa7e7f0
pdf #05875e64
<li class="done0">
cbz #64b5da95
cbz #4a513e39
</ul>
<div id="Book Scraping System-Collections"><h2 id="Collections" class="header"><a href="#Book Scraping System-Collections">Collections</a></h2></div>
<ul>
<li class="done0">
Manual Collections #2e7e6fcf
Manual Collections #b07156f4
<li class="done4">
Automated Collections #81db675a
<li class="done0">
<a href="Automated Collections.html">Automated Collections</a> #f258c1f8
</ul>
<div id="Book Scraping System-State"><h2 id="State" class="header"><a href="#Book Scraping System-State">State</a></h2></div>

113
docs/Client.html Normal file
View File

@@ -0,0 +1,113 @@
<!DOCTYPE html>
<html>
<head>
<link rel="Stylesheet" type="text/css" href="style.css">
<link rel="alternate" type="application/rss+xml" title="RSS" href="rss.xml">
<title>Client</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<p>
<a href="index.html">Home</a> <a href="TOC.html">TOC</a> <a href="https://github.com/th3r00t/pyShelf.git">github</a>
</p>
<div id="Client"><h1 id="Client" class="header"><a href="#Client">Client</a></h1></div>
<p>
<span id="Client-frontend"></span><span class="tag" id="frontend">frontend</span> <span id="Client-ui"></span><span class="tag" id="ui">ui</span>
</p>
<div id="Client-Dependency Management"><h2 id="Dependency Management" class="header"><a href="#Client-Dependency Management">Dependency Management</a></h2></div>
<p>
<span id="Client-Dependency Management-dependency"></span><span class="tag" id="dependency">dependency</span>
</p>
<ul>
<li class="done4">
npm #c5f8d347
<li class="done4">
sass #8f43ab4c
<li class="done0">
pip #14ee256e
</ul>
<div id="Client-[[https://create.t3.gg|T3.gg]]"><h2 id="[[https://create.t3.gg|T3.gg]]" class="header"><a href="#Client-[[https://create.t3.gg|T3.gg]]"><a href="https://create.t3.gg">T3.gg</a></a></h2></div>
<div id="Client-[[https://create.t3.gg|T3.gg]]-User System"><h3 id="User System" class="header"><a href="#Client-[[https://create.t3.gg|T3.gg]]-User System">User System</a></h3></div>
<ul>
<li>
NextAuthjs
<li>
Authentication Providers
<ul>
<li>
Discord
Required: Client ID, Client Secret
<li>
Github
Required: Client ID, Client Secret, only one callback per app.
<img src="https://next-auth.js.org/providers/github" alt="NextAuthjs Github" />
</ul>
</ul>
<div id="Client-[[https://create.t3.gg|T3.gg]]-User Experience"><h3 id="User Experience" class="header"><a href="#Client-[[https://create.t3.gg|T3.gg]]-User Experience">User Experience</a></h3></div>
<p>
<span id="Client-[[https://create.t3.gg|T3.gg]]-User Experience-ux"></span><span class="tag" id="ux">ux</span>
</p>
<ul>
<li class="done0">
Favorites #0fc67f94
<li class="done0">
Permissions / Roles #9c4f279e
<li class="done0">
User Profile #289e0fe0
<li class="done0">
User Settings #51955b33
</ul>
<div id="Client-[[https://create.t3.gg|T3.gg]]-Data Management"><h3 id="Data Management" class="header"><a href="#Client-[[https://create.t3.gg|T3.gg]]-Data Management">Data Management</a></h3></div>
<p>
<span id="Client-[[https://create.t3.gg|T3.gg]]-Data Management-data"></span><span class="tag" id="data">data</span>
</p>
<ul>
<li class="done0">
Book Management System #92e523d2
<ul>
<li class="done0">
add #bda9a0f3
<li class="done0">
remove #4b34e931
<li class="done0">
update #eb959340
<li class="done0">
access level #b00795a4
<li class="done0">
ownership #8c80edc5
<li class="done0">
attach #8acb21a9
<li class="done0">
detach #2e263616
</ul>
</ul>
</body>
</html>

View File

@@ -108,7 +108,7 @@ Filesystem-io
<a href="REST API.html">REST API</a> #c7bc51c5
<li class="done0">
<a href="Frontend.html">Frontend</a> #a76c1038
<a href="Client.html">Client</a> #c68b0664
</ul>
<div id="pyShelf | project:pyshelf-Development"><h2 id="Development" class="header"><a href="#pyShelf | project:pyshelf-Development">Development</a></h2></div>