toshiocp / wnote Goto Github PK

WNote is 'Web Note'. User is a person who has logged in the WNote. Guest is a person who hasn't logged in it. If you want to be a User, you need to sign up first. Users can create and write a note. They can read, modify, save and delete it. Guest can read a note if its r_public switch is on. Otherwise, Guest cannot read it.

Notes can be grouped by the section. Sections also can be grouped by the article. So you can organize your notes, like a paper article.

WNote is in development level.

• Markdown is available
• Decorated with Bootstrap
• tree structure ( user - article - section - note )
• user can login/logout/signup
• user can backup/restore his/her data.
• user can make epub data from his/her article.
• admin can delete any user except him/her.
• user can upload images
• Support Internationalization (English and Japanese)

Ruby 3.1.2, Rails 7.0.3 are required. WNote is configured to use Postgrsql as its database. If you want to use other database, modify 'Gemfile' and 'config/database.yml'. With Postgresql you should notice that postgresql user has to be a SUPERUSER. Because Rails Test does't work without SUPERUSER privilege. Everything except test works well even if you are not a postgresql SUPERUSER. Bootstrap5 and JQuery-UI are required.

1. Download WNote from this repository and decompress it.
2. Download Bootstrap5.
3. Copy bootstrap.css to (WNote)/vendor/assets/stylesheet/bootstrap.css.
4. Copy bootstrap.js to (WNote)/vendor/javascript/bootstrap.js
5. Download JQuery-UI 1.13.1.
6. Copy jquery-ui.js to (WNote)/vendor/assets/javascript/jquery-ui.js
7. Copy external/jquery/jquery.js to (WNote)/vendor/assets/javascript/jquery.js

After the installation above, try to run the WNote in development mode.

$ bin/rails server

Open your browser and connect it to http://localhost:3000.

WNote is running on the Heroku in production mode. (https://floating-shore-5277.herokuapp.com/) If you want to use it, be careful because its version is still in development. You should backup your data, against the unexpected errors.

WNoteは'Web Note（ウェブ上のメモ）'です。 ユーザとはWNoteのウェブサイトにログインした人を指します。 ゲストとはそのサイトにログインしていない人を指します。 ユーザになりたい場合は、まずサインアップ（ユーザ登録）をしてください。 ユーザはWNote上でメモを書いたり保存したりできます。 また、保存したメモを読むこともできます。 ゲストの場合は、r_publicフラグがオンになっているメモを読むことができますが、 オフになっているメモは読むことができません。

メモはセクションにまとめることができます。 また、セクションはアーティクル（記事）にまとめることができます。 このようにして、紙に書かれた記事や論文のように、メモをまとめることができます。

WNoteはまだ開発段階です。

• Markdown仕様で書くことができます
• Bootstrapで体裁を整えて画面表示します
• 木構造 ( user - article - section - note )
• ユーザはログイン、ログアウト、ユーザ登録することができます
• ユーザは自身のデータをバックアップ、リストアできます
• ユーザは自身のアーティクルからepubデータを作成することができます
• 管理者（admin）は自分以外のユーザを削除することができます
• ユーザは画像をアップロードすることができます
• 国際化をサポートしています（英語と日本語）

Ruby 3.1.2, Rails 7.0.3 が必要です。 WNoteは、「Ruby on Rails」とPostgresqlデータベースが必要です。 というのは、HerokuではデータベースにPostgreaqlが使われているからです。 もしも、他のデータベースを使いたい場合は、'Gemfile'と'config/database.yml'を変更してください。 Postgresqlを使う場合、そのユーザはSUPERUSERでなければなりません。 なぜなら、Ruby on RailsのテストはSUPERUSERでないと動作しないからです。 テスト以外の機能はSUPERUSERでなくてもPostgresqlはきちんと動作します。 Bootstrap5 と JQuery-UI が必要です。

1. WNote をこのレポジトリからダウンロードし、解凍する。
2. Bootstrap5 をダウンロードする。
3. bootstrap.css を (WNote)/vendor/assets/stylesheet/bootstrap.css にコピーする。
4. bootstrap.js を (WNote)/vendor/assets/javascript/bootstrap.js にコピーする。
5. JQuery-UI 1.13.1. をダウンロードする。
6. jquery-ui.js を (WNote)/vendr/javascript/jquery-ui.js にコピーする。
7. external/jquery/jquery.js を (WNote)/vendor/assets/javascript/jquery.js にコピーする。

以上のインストールの後に、WNote を development mode で起動してテストしてください。

$ bin/rails server

ブラウザを立ち上げて、http://localhost:3000 を開くとWNoteが現れます。

WNoteはHeroku上で「Ruby on Rails」のプロダクション・モードで動作していますが、まだ不安定です。 (https://floating-shore-5277.herokuapp.com/) 不測の事態に備えてデータをバックアップしておいてください。