Skip to content

Latest commit

 

History

History
100 lines (71 loc) · 3.87 KB

File metadata and controls

100 lines (71 loc) · 3.87 KB
Frappe Suite logo

Frappe Suite

Original, intentionally designed productivity tools

License: AGPL v3 Tests

image

Frappe Suite

Frappe Suite brings seven collaboration products into one Frappe app. Keep files, documents, spreadsheets, presentations, meetings, email, and calendars in one connected workspace.

Product What it does
Drive Store, organize, share, and preview files
Writer Create and collaborate on documents
Sheets Build collaborative spreadsheets
Slides Create and present slide decks
Meet Run video meetings
Mail Manage email in a modern client
Calendar Plan events and manage schedules

Under the Hood

  • Frappe Framework: Provides the database, authentication, permissions, realtime events, and APIs shared by Drive, Writer, Sheets, Slides, Meet, Mail, and Calendar.
  • Frappe UI: Power the interface and reusable components across every Suite product.
  • Yjs: Keeps documents in Writer and spreadsheets in Sheets synchronized during realtime collaboration.
  • Hocuspocus: Runs the collaboration server used for realtime spreadsheet editing in Sheets.
  • mediasoup: Powers Meet's WebRTC selective forwarding unit for group video calls.

Development Setup

Install Bench and create a Frappe site by following the Frappe Framework installation guide.

From your bench directory, get and install Suite:

bench get-app https://github.com/frappe/suite
bench new-site suite.localhost --install-app suite
bench start

In a separate terminal, install frontend dependencies and start the development server:

cd apps/suite
yarn install
yarn dev

To create a production build instead:

bench build --app suite

Meet SFU

Meet requires a separate mediasoup SFU server for video calls. Follow the Frappe Meet SFU setup guide to configure and run it.

Contributing

Contributions are welcome. Please open an issue to report a bug or propose a change before submitting a pull request.

License

Frappe Suite is licensed under the GNU Affero General Public License v3.