ImageUploader

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

README.md (2385B)


      1 # ImageUploader
      2 
      3 ## Purpose
      4 This app is creating for one-time image uploader in Pim.
      5 
      6 ## Design
      7 This app use nextjs. Also it mean that it using node.js and react.
      8 We use bun as package manager.
      9 
     10 ### 構造図
     11 ```mermaid
     12 flowchart 
     13   subgraph client
     14   page -->|router| page2
     15   end
     16   subgraph server
     17   fileUploader
     18   fileManager --> file
     19   end
     20 
     21   Mattermost -->|IdP| page
     22   page -->|file| fileUploader
     23   fileUploader --> file
     24   fileUploader -->|link| page2
     25   page2 -->|script by button| clipboard  
     26 ```
     27 
     28 ### Drawer
     29 |DisplayName|link|describe|
     30 |----------|-----|----------|
     31 |Image uploader home|||
     32 |Index Files|||
     33 |Pim Mattermost|||
     34 |How to Use|||
     35 
     36 ## 参考文献
     37 コピペしたコードがあったらその参照元をここに貼ってください。
     38 あとで多少改変したとしても、貼っていただけると、今後の開発に役立ちます。
     39 
     40 upload formの参考
     41 https://tech.andpad.co.jp/entry/2023/12/10/100000
     42 
     43 fileUploaderの参考
     44 https://zenn.dev/moozaru/articles/b6d46e5787f052
     45 
     46 ## 開発マニュアル(簡易版)
     47 リンクしてあるProjectのTodoを見て、できそうなことがあったら、自分をassignしてください。
     48 作業は自分のところにforkしてもらって、プルリクを投げてください。
     49 作業中の機能をProjectのIn Progressに移動してほしいです。
     50 Image Uploader系のリンク集
     51 [リポジトリ](https://github.com/minerva-jupiter/ImageUploader) [プロジェクト](https://github.com/users/minerva-jupiter/projects/4)
     52 
     53 ### リポジトリの利用法
     54 まず、自分のアカウントにリポジトリをforkしてください。
     55 そこで新しい機能などの開発をしていただき、完成したらプルリクエストをこのリポジトリに投げてください。
     56 
     57 ### 開発環境
     58 パッケージマネージャーはbunを使用しています。
     59 VScodeなりで自分のforkしたリポジトリをコピーして開発してください。
     60 そして、最初にパッケージ一覧をインストールします。```bun install```or```bun i```
     61 プレビューをするために開発鯖を立てます。```bun dev```localhost:3000にアクセスしたらどんなふうな挙動をするかを出してくれます。
     62 何かパッケージを入れたいときは```bun i <packageName>```と入れてください。このへんはnpmとかと変わりません。