128 lines
4.7 KiB
HTML
128 lines
4.7 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>JSDoc: 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/prettify-tomorrow.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="main">
|
|
|
|
<h1 class="page-title">Home</h1>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>manager 1.0.0</h3>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section>
|
|
<article><h1 id="content-manager">Content Manager</h1>
|
|
<p>SERA Websiteのニュース等のコンテンツを管理する</p>
|
|
<h2 id="%E4%BD%BF%E7%94%A8%E8%A8%80%E8%AA%9E%E3%80%81%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E3%83%BC%E3%80%81%E3%83%95%E3%83%AC%E3%83%BC%E3%83%A0%E3%83%AF%E3%83%BC%E3%82%AF%E3%80%81%E3%83%84%E3%83%BC%E3%83%AB">使用言語、ライブラリー、フレームワーク、ツール</h2>
|
|
<ul>
|
|
<li>JavaScript</li>
|
|
<li>express</li>
|
|
<li>htmx</li>
|
|
<li>axios</li>
|
|
<li>node npm</li>
|
|
<li>sqlite</li>
|
|
</ul>
|
|
<h2 id="%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95">使用方法</h2>
|
|
<pre class="prettyprint source lang-bash"><code>cd src-manager/ # このディレクトリーに移動
|
|
npm install # 依存パッケージのインストール、まだ一度も実行していない場合
|
|
npm start # サーバーを起動、ブラウザで http://localhost:3001 に入る
|
|
npm run dev # JSファイル変更時に自動リロードが入る開発サーバーを起動する。同じく http://localhost:3001 でホストされる
|
|
npm run documentation # ドキュメンテーションを生成, "./docs/manager/<バージョン>/" 内で `python -m http.server` 等でローカルでホストする
|
|
</code></pre>
|
|
<h2 id="%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9">データベース</h2>
|
|
<h3 id="%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%EF%BC%9A-news.db-%2F-%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%3A-news">ファイル： news.db / テーブル: news</h3>
|
|
<ul>
|
|
<li>id - PRIMARY KEY - 整数</li>
|
|
<li>date - Unix時間 - 整数</li>
|
|
<li>entryType - 記事(0) か ツイート風(1) - 整数</li>
|
|
<li>cardContent - ニュースリストで表示されるコンテンツ、Markdown可 - 文字列(Markdown)</li>
|
|
<li>article - Markdownで書かれた記事 - 文字列(Markdown)</li>
|
|
<li>linkPath - ニュースリストで表示されるリンク先 - 文字列</li>
|
|
<li>coverImagePath - ニュースリストで表示される画像へのパス - 文字列</li>
|
|
</ul>
|
|
<h3 id="%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%3A-gallery.db-%2F-%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB%3A-gallery">ファイル: gallery.db / テーブル: gallery</h3>
|
|
<ul>
|
|
<li>id - PRIMARY KEY - 整数</li>
|
|
<li>imagePath - 画像へのパス - 文字列</li>
|
|
<li>caption - 画像の説明文 - 文字列</li>
|
|
</ul>
|
|
<h2 id="api(restful)">API(RESTful)</h2>
|
|
<ul>
|
|
<li>
|
|
<p><code>/api/news</code></p>
|
|
<ul>
|
|
<li>GET(<code>/</code>): Unix時間で特定されたニュースの情報を取得する - <code>?target=<Unix時間></code></li>
|
|
<li>GET(<code>/list</code>): HTML/HTMX形式で全ニュースの情報を取得する</li>
|
|
<li>GET(<code>/list-unwrapped</code>): JSON形式で全ニュースの情報を取得する</li>
|
|
<li>POST: 新しいニュースを作成する</li>
|
|
<li>PUT: ニュースの内容を更新する</li>
|
|
<li>DELETE: Unix時間で特定されたニュースを削除する - <code>?target=<Unix時間></code></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>/api/gallery-image</code></p>
|
|
<ul>
|
|
<li>GET(<code>/</code>): IDで指定された画像へのパスと説明文を取得する - <code>?target=<ID></code></li>
|
|
<li>GET(<code>/list</code>): HTML/HTMX形式で全画像の情報を取得する</li>
|
|
<li>GET(<code>/list-unwrapped</code>): JSON形式で全画像の情報を取得する</li>
|
|
<li>POST: 新しい画像の情報を追加する</li>
|
|
<li>PUT: 画像の情報を更新する</li>
|
|
<li>DELETE: IDで指定された画像の情報を削除する - <code>?target=<ID></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul></article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<nav>
|
|
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-api_gallery-image.html">api/gallery-image</a></li><li><a href="module-api_news.html">api/news</a></li><li><a href="module-utils_asyncDatabase.html">utils/asyncDatabase</a></li><li><a href="module-utils_tableWrapper.html">utils/tableWrapper</a></li></ul>
|
|
</nav>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Tue Nov 26 2024 23:18:12 GMT+0900 (日本標準時)
|
|
</footer>
|
|
|
|
<script> prettyPrint(); </script>
|
|
<script src="scripts/linenumber.js"> </script>
|
|
</body>
|
|
</html> |