Skip to content

Latest commit

 

History

History
131 lines (103 loc) · 9.19 KB

README.md

File metadata and controls

131 lines (103 loc) · 9.19 KB
Raw

 

Lyvely Lyvely

Lyvely is a flexible self-management and collaboration platform designed for both individual and team usage. It serves as a ready-to-use solution and furthermore offers a powerful framework for building customized collaboration platforms.

⚠️ Lyvely is an actively developed project, and its features and APIs are subject to ongoing improvements and refinements. We welcome contributions from the community to help shape the future of Lyvely and make it even more valuable to users.

What sets Lyvely apart?

  • It supports versatile use-cases from individual users, groups to organizations.
  • It supports multiple profiles per user from private and public user profiles to groups and organization profiles.
  • Lyvely is very flexible and offers a powerful module system for adding new features.
  • It has been designed with simplicity in mind, without overwhelming users with a multitude of icons and unused features.
  • It supports a unique way of organizing content with multi-level sub-discussions.
  • In addition to basic collaboration features, the platform offers ways to track and analyze time series data such as habits or company data, journals.
  • There is no restrictions on how to use the platform, use the flexible set of features as it suits your use case.
  • Instead of focusing on external integrations, the aim is to enable seamless integration between features through the module system.

Getting Started

To get started with Lyvely, follow the installation instructions in our documentation.

Core Features

The following selection of features are part of the Lyvely core.

  • 🏠 Profiles: Private-, Group- and Organization profiles serve as home for your content and users.
  • 💬 Main Stream: A chat-like view containing all sorts of content within a profile.
  • 💭 Content Stream: Each content entry itself can be discussed within an own chat-like Content Stream.
  • ✉️ Messages: The most simple form of content with markdown support.
  • ⭐ Tags: Mark and filter your content with the help of tags.
  • 🚀 Features: Manage and utilize Features as additional content types within your profiles.

Feature Modules

The following optional modules are maintained within this repository.

  • 😀 Habits: Efficiently manage daily, weekly, monthly, quarterly, yearly, or non-scheduled activities. Whether it's personal habits or team and organization-related activities, Lyvely has you covered. A habit can be defined as shared or per-user.
  • ☑️ Tasks: Organize individual or team tasks using a Calendar Planner. A task can be defined as shared or per-user.
  • 🎯 Milestones: Assign and keep track of your content by assigning it to a milestone.
  • 📝 Journals: Keep track of and evaluate any data over time to make informed decisions. A journal can be defined as shared or per-user.
  • 📈 Analytics: Visualize and compare your data using customizable time series and various chart types.
  • 📜 Legal: Define translatable your communities Privacy Notes and Terms of Service or other legal texts.

Core APIs

The following core APIs form the basis for building flexible and expandable communication platforms with Lyvely:

  • Profiles: Support for multiple profiles per user, including private, group, and organizational profiles.
  • Content: Implement new types of content to meet your specific requirements.
  • Features: Define configurable feature switches to customize your collaboration environment.
  • Permission Management: Elaborate control over who can access and modify content and features within profiles.
  • Policies: Create reusable and replaceable rules within your network for consistent governance.
  • Live Updates: Keep your UI synchronized with real-time updates.
  • Content Stream: Engage in discussions, take notes, and brainstorm with ease.
  • Tags: Categorize and filter content for efficient organization.
  • Notifications: Stay informed about network activities through various channels, such as email and push notifications.

Libraries

Lyvely extends its functionality through a set of additional libraries, commonly employed for core and feature development. These libraries enhance various aspects of the application:

  • @lyvely/ui The UI component library provides a collection of core user interface components. These components are extensively utilized in both the core application and various feature modules. @lyvely/ui ensures consistency in design and user experience across Lyvely's interface.
  • @lyvely/time-series The time series module is a versatile tool for tracking and analyzing data over time. It plays a vital role in the journals and activities feature, enabling you to monitor trends, patterns, and historical data within Lyvely.
  • @lyvely/calendar-plan This library is essential for feature modules like activities and journals. It offers interfaces and components to create customized calendar plan features. With @lyvely/calendar-plan, you can efficiently manage and visualize schedules and events within your collaboration environment.
  • @lyvely/common The common library serves as a repository for frequently used features shared between the frontend and backend.
  • @lyvely/dates The dates library simplifies date and time-related operations, offering a range of useful features for managing time-sensitive data. It enhances Lyvely's capability to work with dates.
  • @lyvely/devtools Provides shared configurations and build tools.

Powered By

Lyvely is designed as Single Page Application (SPA) and Progressive Web App (PWA) with a robust technology stack that ensures flexibility, performance, and scalability. Here's an overview of the key technologies and frameworks that power Lyvely:

  • TypeScript: The use of TypeScript in both the frontend and backend enables code sharing and typesafe interfaces. It combines the flexibility of JavaScript with the benefits of static typing, contributing to a more robust and maintainable codebase.
  • Vue.js: The frontend is built on Vue.js, one of the leading JavaScript frameworks. Vue.js provides a flexible and modern web frontend, enabling a responsive and interactive user interface that adapts seamlessly to various devices.
  • Tailwind CSS: Lyvely's user interface is crafted with Tailwind CSS, a utility-first CSS framework. Combined with a custom component library, Tailwind CSS delivers a unique and visually appealing user experience while maintaining maintainability and consistency in styling.
  • NestJS: The backend of Lyvely is driven by NestJS, a robust framework for building scalable and maintainable server-side applications. NestJS offers tools for implementing a clean and modular architecture, ensuring code organization and extensibility.
  • MongoDB: Lyvely leverages MongoDB as its data store. This choice enables a flexible approach for building scalable, content-centric applications.
  • Redis: Redis serves as a multipurpose key-value store, providing reliability for caching, queuing and messaging within Lyvely.

License

Copyright (C) 2022-2024 Julian Harrer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Contact Us

If you have any questions, suggestions, or need assistance, feel free to contact us.