{"id":13467620,"url":"https://github.com/revoltchat/revite","last_synced_at":"2025-04-13T08:56:07.967Z","repository":{"id":36995616,"uuid":"379348282","full_name":"revoltchat/revite","owner":"revoltchat","description":"Revolt client built with Preact.","archived":false,"fork":false,"pushed_at":"2025-01-29T13:42:38.000Z","size":8457,"stargazers_count":921,"open_issues_count":122,"forks_count":222,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-06T05:06:47.964Z","etag":null,"topics":["preact","react","revolt","vite"],"latest_commit_sha":null,"homepage":"https://app.revolt.chat","language":"TypeScript","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/revoltchat.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,"dei":null,"publiccode":null,"codemeta":null},"funding":{"ko_fi":"insertish","custom":"https://insrt.uk/donate"}},"created_at":"2021-06-22T17:21:08.000Z","updated_at":"2025-04-04T04:51:33.000Z","dependencies_parsed_at":"2024-03-15T20:50:30.280Z","dependency_job_id":"5d42868e-1521-4987-9b49-32e8ab0a26da","html_url":"https://github.com/revoltchat/revite","commit_stats":{"total_commits":1463,"total_committers":70,"mean_commits":20.9,"dds":"0.40669856459330145","last_synced_commit":"00e6ead9bd6ed84ecc3b8538e9c271102f7353df"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revoltchat%2Frevite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revoltchat%2Frevite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revoltchat%2Frevite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/revoltchat%2Frevite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/revoltchat","download_url":"https://codeload.github.com/revoltchat/revite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248688545,"owners_count":21145764,"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":["preact","react","revolt","vite"],"created_at":"2024-07-31T15:00:58.538Z","updated_at":"2025-04-13T08:56:07.944Z","avatar_url":"https://github.com/revoltchat.png","language":"TypeScript","readme":"# Deprecation Notice\n\nThis project is deprecated, however it still may receive maintenance updates.\n\nPRs for small fixes are more than welcome.\n\n## Deploying a new release\n\nEnsure `.env.local` points to `https://app.revolt.chat/api`.\n\n```bash\ncd ~/deployments/revite\ngit pull\ngit submodule update\n\n# check:\ngit status\n\nexport REVOLT_SAAS_BRANCH=revite/main\nexport REMOTE=root@production\nscripts/publish.sh\n\n# SSH in and restart revite:\nssh $REMOTE\ntmux a -t 4\n```\n\n# Revite\n\n## Description\n\nThis is the web client for Revolt, which is also available live at [app.revolt.chat](https://app.revolt.chat).\n\n## Pending Rewrite\n\nThe following code is pending a partial or full rewrite:\n\n-   `src/components`: components are being migrated to [revoltchat/components](https://github.com/revoltchat/components)\n-   `src/styles`: needs to be migrated to [revoltchat/components](https://github.com/revoltchat/components)\n-   `src/lib`: this needs to be organised\n\n## Stack\n\n-   [Preact](https://preactjs.com/)\n-   [Vite](https://vitejs.dev/)\n\n## Submodule Hint\n\nThis project contains submodules. Run `git submodule init` after you clone this repository to initialize the submodules.\nIt is also recommended to run `git submodule update` after you pull from upstream.\n\n## Resources\n\n### Revite\n\n-   [Revite Issue Board](https://github.com/revoltchat/revite/issues)\n-   [Google Drive Folder with Screenshots](https://drive.google.com/drive/folders/1Ckhl7_9OTTaKzyisrWHzZw1hHj55JwhD)\n\n### Revolt\n\n-   [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here)\n-   [Revolt Testers Server](https://app.revolt.chat/invite/Testers)\n-   [Contribution Guide](https://developers.revolt.chat/contributing)\n\n## Quick Start\n\nGet revite up and running locally.\n\n```\ngit clone --recursive https://github.com/revoltchat/revite\ncd revite\nyarn\nyarn build:deps\nyarn dev\n```\n\nYou can now access the client at http://local.revolt.chat:3000.\n\n## CLI Commands\n\n| Command                                 | Description                                  |\n| --------------------------------------- | -------------------------------------------- |\n| `yarn pull`                             | Setup assets required for Revite.            |\n| `yarn dev`                              | Start the Revolt client in development mode. |\n| `yarn build`                            | Build the Revolt client.                     |\n| `yarn build:deps`                       | Build external dependencies.                 |\n| `yarn preview`                          | Start a local server with the built client.  |\n| `yarn lint`                             | Run ESLint on the client.                    |\n| `yarn fmt`                              | Run Prettier on the client.                  |\n| `yarn typecheck`                        | Run TypeScript type checking on the client.  |\n| `yarn start`                            | Start a local sirv server with built client. |\n| `yarn start:inject`                     | Inject a given API URL and start server.     |\n| `yarn lint \\| egrep \"no-literals\" -B 1` | Scan for untranslated strings.               |\n\n## License\n\nRevite is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/revite/blob/master/LICENSE).\n","funding_links":["https://ko-fi.com/insertish","https://insrt.uk/donate"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevoltchat%2Frevite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frevoltchat%2Frevite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frevoltchat%2Frevite/lists"}