{"id":13630275,"url":"https://github.com/chrisvel/wreeto_official","last_synced_at":"2025-04-17T13:32:11.352Z","repository":{"id":38997617,"uuid":"262365923","full_name":"chrisvel/wreeto_official","owner":"chrisvel","description":"Wreeto is an open source note-taking, knowledge management and wiki system.","archived":false,"fork":false,"pushed_at":"2023-02-04T17:13:12.000Z","size":12622,"stargazers_count":386,"open_issues_count":26,"forks_count":13,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-08-01T22:45:43.531Z","etag":null,"topics":["docker","knowledge-management","note-taking","notes","notetaking-applications","rails","rails-framework","research","ruby","wiki"],"latest_commit_sha":null,"homepage":"https://wreeto.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chrisvel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-05-08T15:56:03.000Z","updated_at":"2024-06-15T17:45:02.000Z","dependencies_parsed_at":"2023-02-11T21:45:53.804Z","dependency_job_id":null,"html_url":"https://github.com/chrisvel/wreeto_official","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisvel%2Fwreeto_official","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisvel%2Fwreeto_official/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisvel%2Fwreeto_official/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chrisvel%2Fwreeto_official/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chrisvel","download_url":"https://codeload.github.com/chrisvel/wreeto_official/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223757396,"owners_count":17197549,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","knowledge-management","note-taking","notes","notetaking-applications","rails","rails-framework","research","ruby","wiki"],"created_at":"2024-08-01T22:01:36.836Z","updated_at":"2025-04-17T13:32:11.346Z","avatar_url":"https://github.com/chrisvel.png","language":"JavaScript","funding_links":["https://paypal.me/wreeto"],"categories":["JavaScript","docker","Happy Exploring 🤘"],"sub_categories":[],"readme":"![Logo](/public/header_logo.png?raw=true)\n\n### {{ [twitter](https://twitter.com/wreeto_official) ~ [reddit](https://www.reddit.com/r/wreeto/) }}\n\n## WARNING! \n_v3 is not compatible with v2, you will have to export your notes in v2 and import them in v3._\n_This happens because v3 is almost a re-write of v2._\n\n## Introduction\n\nWreeto is an open source note-taking, knowledge management and wiki system built on top of Ruby on Rails framework.  \n\nInitially 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.\n\n### Current stable version: _v2.6.8_\n### Latest version: _master_ or _v3.0.1.beta_\n\n## Table of Contents \n1. [Features](#features)\n2. [Roadmap](#roadmap)\n3. [Requirements](#requirements)\n4. [Installation](#installation)\n5. [Usage](#usage) \n6. [How can you help](#how-can-you-help)\n7. [Screenshots](#screenshots) \n8. [License](#license) \n9. [Professional edition](#professional-edition)\n\n## \u003ca name=\"features\"\u003e\u003c/a\u003e 1. Features \n\n- Simple, minimal UI - _less is more_\n- Create unlimited notes with Markdown format\n- Categories\n- Tags \n- Projects \n- Attachments \n- Backlinks (**new!**)\n- Graph view (**new!**)\n- Encrypted backups\n- List notes by Category or SubCategory\n- Favorite notes appear on the top of the notes list and sidebar\n- Authentication, authorization \n- Google oAuth integration\n- Search\n- Share notes in public with a __secure__ link\n- Zip and download notes in markdown format\n- Import notes from external, zipped, text-only files\n- Responsive mobile web UI\n\n## \u003ca name=\"roadmap\"\u003e\u003c/a\u003e 2. Roadmap \n\n- Test everything, everywhere. More testing..\n- Note Templates\n- Encryption\n- Different Levels of security access for users\n- User access control\n- Dark mode\n- Quick notes that auto-expire \n- Export notes to PDF format\n- Cloud backups\n- Version tracking\n- Move UI to ReactJS\n- Mobile apps\n- A lot more ..\n\n## \u003ca name=\"requirements\"\u003e\u003c/a\u003e 3. Requirements\n\n- Docker (optional)\n  \nor \n\n- Ruby 2.6.6\n- PostgreSQL 11\n- Redis 5.0.7\n\n## \u003ca name=\"installation\"\u003e\u003c/a\u003e 4. Installation\n\n### 4.1 Set up your environment \n\nCopy the `.env.development.local` to `.env`:\n\n```\ncp .env.development.local .env \n```\n\nand set up your variables:\n\n```\nOAUTH_GOOGLE_ID=\nOAUTH_GOOGLE_SECRET=\nPOSTGRES_HOST=postgres\nPOSTGRES_USER=wreeto_admin\nPOSTGRES_PASSWORD=wreeto_password\nPOSTGRES_DB=wreeto_db\nPOSTGRES_PORT=5432\nRACK_ENV=production\nRAILS_ENV=production\nRECAPTCHA_SITE_KEY=\nRECAPTCHA_SECRET_KEY=\nREDIS_HOST=redis\nREDIS_PASSWORD=\nSMTP_USERNAME=\nSMTP_PASSWORD=\nWREETO_HOST=localhost # your IP Address or domain \nWREETO_PORT=8383\n```\n\n### 4.2 Use docker\n\nThe easiest way to get started *now* is to use `docker-compose` and simply execute:\n\nFor running the latest version (might be unstable) use `image: chrisvel/wreeto:master`. Instead use the latest stable version as (example) `image: chrisvel/wreeto:version-`.\n\n```\ndocker-compose up\n```\n\nIf 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`. \n\nIn order to initialize the database and load the default account, you'll need to run: \n\n```\ndocker-compose run app bundle exec rake db:drop db:migrate db:setup\n``` \n\n### 4.3 Install locally \n\nYou will need to setup postgres, ruby, redis and their appropriate dependencies necessary by your O/S and environment. \n\nAs for every Rails project:\n- `bundle install`\n- `bundle exec rake db:drop db:migrate db:setup`\n- `bundle exec rails s`\n\nDo not forget to create the `.env` file. \n\n## \u003ca name=\"usage\"\u003e\u003c/a\u003e 5. Usage\n\n### 5.1 Default account \n\nThe default credentials are: username `admin` and password `password`.\n\n### 5.2 Create a new account (rails console)\n\nYou 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\n\n```\naccount = Account.create!\nUser.create!({username: 'admin', email: 'user@email.com', password: 'password', confirmed_at: DateTime.now, account: account})\n```\n\nby changing the values as you wish, then `exit`. \n\n### 5.3 Web UI\n\nTo access the web application with default settings (hostname/port) please go to\n\n```\nhttp://localhost:8383\n```\n\n## \u003ca name=\"how-can-you-help\"\u003e\u003c/a\u003e 6. How can you help\n\nThere are several ways you can help with wreeto:  \n\n1. Try **wreeto** and send your feedback, comments or suggestions.\n2. Clone the repo, develo and create a _Pull Request_\n3. Spread the word about **wreeto** to your friends and your community. This is the way the project breaths and grows.  \n4. Sponsor me through Github sponsors or donate to **Paypal:** [paypal.me/wreeto](https://paypal.me/wreeto)\n\n## \u003ca name=\"screenshots\"\u003e\u003c/a\u003e 7. Screenshots\n\n#### Login\n![Screenshot Running Command](/public/screenshots/scr_1.png?raw=true)\n\n#### Notes Inventory\n![Screenshot Running Command](/public/screenshots/scr_2.png?raw=true)\n\n#### Private Note View\n![Screenshot Running Command](/public/screenshots/scr_3.png?raw=true)\n\n#### Public Note View\n![Screenshot Running Command](/public/screenshots/scr_4.png?raw=true)\n\n#### Category Items\n![Screenshot Running Command](/public/screenshots/scr_5.png?raw=true)\n\n#### Create a new Note \n![Screenshot Running Command](/public/screenshots/scr_6.png?raw=true)\n\n#### Categories list\n![Screenshot Running Command](/public/screenshots/scr_7.png?raw=true)\n\n#### Wiki view\n![Screenshot Running Command](/public/screenshots/scr_8.png?raw=true)\n\n#### Search\n![Screenshot Running Command](/public/screenshots/scr_9.png?raw=true)\n\n## \u003ca name=\"license\"\u003e\u003c/a\u003e 8. License\n\nAGPLv3 License for the community version \n\n## \u003ca name=\"professional-edition\"\u003e\u003c/a\u003e 9. Premium edition \n\nThere is a premium version and there is a pricing plan for this edition. Please check https://wreeto.com or email to \u003cwreeto.official and gmail as the domain provider\u003e for more details (currently updating).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisvel%2Fwreeto_official","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchrisvel%2Fwreeto_official","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchrisvel%2Fwreeto_official/lists"}