{"id":13554487,"url":"https://github.com/okbreathe/quasar","last_synced_at":"2025-04-03T07:31:31.292Z","repository":{"id":136632306,"uuid":"88105666","full_name":"okbreathe/quasar","owner":"okbreathe","description":"React and Elixir Powered Wiki","archived":false,"fork":false,"pushed_at":"2017-04-17T20:25:13.000Z","size":197,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-04T02:32:55.267Z","etag":null,"topics":["elixir","note-taking","phoenix","react","wiki"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/okbreathe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2017-04-12T23:34:49.000Z","updated_at":"2021-12-19T16:46:20.000Z","dependencies_parsed_at":"2024-01-14T16:11:04.666Z","dependency_job_id":"d4133358-5a89-4fae-bebe-a78919587370","html_url":"https://github.com/okbreathe/quasar","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okbreathe%2Fquasar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okbreathe%2Fquasar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okbreathe%2Fquasar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/okbreathe%2Fquasar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/okbreathe","download_url":"https://codeload.github.com/okbreathe/quasar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246956456,"owners_count":20860440,"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":["elixir","note-taking","phoenix","react","wiki"],"created_at":"2024-08-01T12:02:48.845Z","updated_at":"2025-04-03T07:31:30.799Z","avatar_url":"https://github.com/okbreathe.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","elixir"],"sub_categories":[],"readme":"# Quasar\n\nQuasar is a [React](https://facebook.github.io/react/) powered Markdown wiki consuming a [Phoenix](http://www.phoenixframework.org/)-based API.\n\n[Demo](https://okbreathe.github.io/quasar-demo/)\n\n## Features\n\n* Markdown editor via [Ace](https://ace.c9.io/)\n* Drag and Drop File Upload\n* Autosaving and Snapshots\n* Themeing and Typography Control\n* Tagging and Filtering\n* Vim and Emacs Emulation Modes\n\n**IE is not supported.**\n\n## Tour\n\n#### Creating Pages\n\nYou can create a new page by pressing the `+` icon next to the search box. Pages can have one or more tags. When you create a page it will be automatically tagged with the tag that is currently selected. If no tag is selected the page can be found under \"All Notes\" until it is tagged.\n\n#### Revisions\n\nQuasar will autosave every three minutes. If you have unsaved changes the sync icon in the upper-right corner will be red. To save immediately either press the icon or use the `control + s` shortcut. Autosaves will be deleted after 100 saves starting with the oldest. If you would like to have a permanent snapshot of a page you can use the revision menu to the left of the save icon to create an explicit snapshot that will never be deleted.\n\n#### Customization\n\nYou can customize your experience via the settings menu which can be accessed from the menu icon in the upper left. In the lower right-hand corner you can favorite, trash a page or change the view (editor-only, preview-only or split screen).\n\nThat's it!\n\n## Installation\n\n* Make sure you have the dependencies installed ( Postgres 9.2+, NodeJS, [Yarn](https://yarnpkg.com/en/), [Elixir](elixir-lang.org) )\n* Inside the project, install Elixir dependencies with `mix deps.get`\n* Install JavaScript dependencies with `cd assets \u0026\u0026 yarn install \u0026\u0026 cd ../`\n* Create your database with `mix ecto.create`\n* Migrate your database with `mix ecto.migrate` or seed the database with test data via `mix ecto.setup`\n* Start Phoenix endpoint with `mix phx.server`\n\nNow you can visit [`localhost:4000`](http://localhost:4000) from your browser.\n\n### Configuration\n\nFor changes in development mode, you can edit `config/dev.exs`. In production you can configure Quasar by creating a `config/prod.secret.exs` file. Copy `config/prod.secret.exs.example` to `config/prod.secret.exs` and edit in your details.\n\n```elixir\n# If true users can create new accounts through the web interface\nconfig :quasar,\n  allow_registration: false\n\n# Store files on disk\nconfig :arc,\n  storage: Arc.Storage.Local\n\n# Or use AWS for storage\nconfig :arc,\n  storage: Arc.Storage.S3,\n  bucket: \"your-bucket\"\n\nconfig :ex_aws,\n  access_key_id: [{:system, \"AWS_ACCESS_KEY_ID\"}, :instance_role],\n  secret_access_key: [{:system, \"AWS_SECRET_ACCESS_KEY\"}, :instance_role]\n\n# Sending Email\n# Only used for sending out forgotten password emails\n# For other adapters see [Bamboo](https://github.com/thoughtbot/bamboo)'s docs\nconfig :quasar, Quasar.Mailer,\n  adapter: Bamboo.MandrillAdapter,\n  api_key: \"my_api_key\"\n\n# Used to generate short filenames for uploads\nconfig :quasar,\n  upload_salt: \"put your unique phrase here\"\n```\n\n## In Production\n\nProduction releases can be handled by [distillery](https://github.com/bitwalker/distillery). To create a production release:\n\n```bash\n# Get dependencies\nmix deps.get\n# Compile assets\nmix phx.digest\n# Edit your production configuration\ncp config/prod.secret.exs.example config/prod.secret.exs\n# Build release. Note that PORT and HOST are optional and will default to the specified values\nMIX_ENV=prod PORT=4000 HOST=localhost mix release --env=prod\n# Much compiling later\n==\u003e Release successfully built!\n    You can run it in one of the following ways:\n      Interactive: _build/prod/rel/quasar/bin/quasar console\n      Foreground: _build/prod/rel/quasar/bin/quasar foreground\n      Daemon: _build/prod/rel/quasar/bin/quasar start\n# Start the app\n./_build/prod/rel/quasar/bin/quasar start\n```\n\nSince you won't have access to mix in production, you can create a new user by connecting a console to the running release.\n\n```bash\n./_build/prod/rel/quasar/bin/quasar remote_console\n```\n\nNow run the user generation command in IEx.\n\n```elixir\niex(1)\u003e Quasar.Accounts.generate(\"user\", \"user@email.com\", \"password\")\n```\n\n### Deployment\n\nQuasar can be deployed using  [edeliver](https://github.com/boldpoker/edeliver). To get started copy the `.deliver/config.example` to `.deliver/config` and edit in your configuration. The host will also require [Yarn](https://yarnpkg.com/) and [Elixir](http://elixir-lang.org/) to be available.\n\nFor other options please [check the deployment](http://www.phoenixframework.org/docs/deployment) and [advanced deployment](http://www.phoenixframework.org/docs/advanced-deployment) guides. It is recommended to run Quasar behind a proxy like `nginx`. See the [guide](http://www.phoenixframework.org/docs/serving-your-application-behind-a-proxy) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokbreathe%2Fquasar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fokbreathe%2Fquasar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fokbreathe%2Fquasar/lists"}