Wreeto是一个基于Ruby on Rails框架的开源笔记，知识管理和Wiki系统

Wreeto是一个基于Ruby on Rails框架的开源笔记，知识管理和Wiki系统

{{ twitter ~ reddit }}

Introduction

Wreeto is an open source note-taking, knowledge management and wiki system built on top of Ruby on Rails framework.

Initially this was built because I didn't like the note-taking apps out there and I wanted something simple, structured and straightforward, with no bells and whistles.

Current version: v2.1.5

Table of Contents

FeaturesRoadmapRequirementsInstallationUsageScreenshotsLicenseProfessional edition

1. Features

Simple, minimal UI - less is moreCreate unlimited notes with Markdown formatUnlimited CategoriesUnlimited Tags (new!)List notes by Category or SubCategoryFavorite notes appear on the top of the notes list and sidebarAuthentication, authorizationGoogle oAuth integrationSearchShare notes in public with a secure linkZip and download notes in markdown formatResponsive mobile web UI

2. Roadmap

Test everything, everywhere. More testing..Improve UI inconsistenciesUpgrade to Rails v6Note TemplatesAbility to attach files (e.g. Documents)EncryptionDifferent Levels of security access for usersUser access controlDark modeExport notes to PDF formatCloud backupsVersion trackingMove UI to ReactJSMobile appsA lot more ..

3. Requirements

docker (optional)

or

Ruby 2.6.6PostgreSQL 11Redis 5.0.7

4. Installation

4.1 Set up your environment

Copy the .env.development.local to .env:

cp .env.development.local .env

and set up your variables:

OAUTH_GOOGLE_ID=OAUTH_GOOGLE_SECRET=POSTGRES_HOST=postgresPOSTGRES_USER=wreeto_adminPOSTGRES_PASSWORD=wreeto_passwordPOSTGRES_DB=wreeto_devPOSTGRES_PORT=5432RACK_ENV=developmentRAILS_ENV=developmentRECAPTCHA_SITE_KEY=RECAPTCHA_SECRET_KEY=REDIS_HOST=redisREDIS_PASSWORD=SMTP_USERNAME=SMTP_PASSWORD=WREETO_HOST=localhost # your IP Address or domain WREETO_PORT=8383

4.2 Use docker

The easiest way to get started now is to use docker-compose and simply execute:

docker-compose up

If you decide to just copy the docker-compose.yml file in order to deploy it locally, you'll also need to create .env (instructions in 4.1) and docker-entrypoint.sh. Make sure to add execute permissions to it sudo chmod +x docker-entrypoint.sh.

In order to initialize the database and load the default account, you'll need to run:

docker-compose run app bundle exec rake db:drop db:migrate db:setup

4.3 Install locally

You will need to setup postgres, ruby, redis and their appropriate dependencies necessary by your O/S and environment.

As for every Rails project:

bundle installbundle exec rake db:drop db:migrate db:setupbundle exec rails s

Do not forget to create the .env file.

5. Usage

5.1 Default account

The default credentials are: username user@email.com and password password.

5.2 Create a new account (rails console)

You can create another account from the Rails console by running bundle exec rails console or docker-compose run app bundle exec rails console and then

User.create!({firstname: 'John', lastname: 'Murdock', email: 'user@email.com', password: 'password', confirmed_at: DateTime.now})

by changing the values as you wish, then exit.

5.3 Web UI

To access the web application with default settings (hostname/port) please go to

http://localhost:8383

6. Screenshots

Login

Notes Inventory

Private Note View

Public Note View

Category Items

Create a new Note

Categories list

Wiki view

Search

7. License

AGPLv3 License for the community version

8. Professional edition

There is a professional version and there is a pricing plan for this edition. Please check https://wreeto.com for more details (currently updating).

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。