acid-info
/
lw-api-poc
mirror of https://github.com/acid-info/lw-api-poc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
lw-api-poc/README.md

1.3 KiB
Raw Permalink Blame History

README.md

Logos Wiki Framework MVP - Development Proposal

This repository contains the development proposal for the Logos Wiki Framework MVP, a comprehensive and collaborative knowledge platform that put value not only to content but also the context, and easy to maintain.

Key Features:

  • Collaborative content creation using a frontend editor and GitHub
  • Automatic context augmentation with visual citation and context enrichment
  • Semantic search and generative Q&A features
  • Real-time knowledge graph visualization

Technical Details

Technical Architecture and Tech Stack:

  • Frontend: React, Editor.js
  • Backend: NestJS (we use express for the POC)
  • Content Storage & Database: GitHub and Weaviate
  • User Management: Supabase with GitHub Auth

Installation

  1. Clone the repository locally.
  2. cd into the cloned directory.
  3. Run yarn install to install all dependencies.
  4. Run yarn start:dev to start the development server.

Contribution Guidelines and Best Practices

  • Adhere to a standardized content structure and formatting guidelines
  • Prioritize accuracy and relevance when contributing content
  • Engage in active collaboration with other contributors and team members

License

This project is licensed under the MIT License - see the LICENSE.md file for details.