Updated Content Manager README

This commit is contained in:
2024-09-17 00:49:58 +09:00
parent 850ced37de
commit a55bd18ebc

View File

@@ -7,6 +7,7 @@ SERA Websiteのニュース等のコンテンツを管理する
* JavaScript * JavaScript
* express * express
* htmx * htmx
* axios
* node npm * node npm
* sqlite * sqlite
@@ -16,7 +17,7 @@ SERA Websiteのニュース等のコンテンツを管理する
cd src-manager/ # このディレクトリーに移動 cd src-manager/ # このディレクトリーに移動
npm install # 依存パッケージのインストール、まだ一度も実行していない場合 npm install # 依存パッケージのインストール、まだ一度も実行していない場合
npm start # サーバーを起動、ブラウザで http://localhost:3001 に入る npm start # サーバーを起動、ブラウザで http://localhost:3001 に入る
npm run dev # ファイル変更時に自動リロードが入る開発サーバーを起動する。同じく http://localhost:3001 でホストされる npm run dev # JSファイル変更時に自動リロードが入る開発サーバーを起動する。同じく http://localhost:3001 でホストされる
``` ```
## データベース ## データベース
@@ -26,9 +27,17 @@ npm run dev # ファイル変更時に自動リロードが入る開発サーバ
* id - PRIMARY KEY - 整数 * id - PRIMARY KEY - 整数
* date - Unix時間 - 整数 * date - Unix時間 - 整数
* entryType - 記事(0) か ツイート風(1) - 整数 * entryType - 記事(0) か ツイート風(1) - 整数
* cardcontent - ニュースリストで表示されるコンテンツ、Markdown可 - 文字列(Markdown) * cardContent - ニュースリストで表示されるコンテンツ、Markdown可 - 文字列(Markdown)
* article - Markdownで書かれた記事 - 文字列(Markdown) * article - Markdownで書かれた記事 - 文字列(Markdown)
* linkPath - ニュースリストで表示されるリンク先 - 文字列 * linkPath - ニュースリストで表示されるリンク先 - 文字列
* coverImagePath - ニュースリストで表示される画像へのパス - 文字列 * coverImagePath - ニュースリストで表示される画像へのパス - 文字列
## API ## API(RESTful)
* `/api/news`
* GET: Unix時間で特定されたニュースの情報を取得する - `?target=<Unix時間>`
* POST: 新しいニュースを作成する
* PUT: ニュースの内容を更新する
* DELETE: Unix時間で特定されたニュースを削除する - `?target=<Unix時間>`
* `/api/news-list`
* GET: 全ニュースの情報を取得する