Looksyk

A simple personal knowledge platform with a focus on clean markdown files, simple queries and a journal.

---

Project maintained by SebastianRzk Hosted on GitHub Pages — Theme by mattgraham

Development Build

Table of Contents

This page

• Build backend and frontend
• Build electron app
• Contribution Guidelines

Further Reading

• Overview
• idea and technical concept
• Install + Run
• Migrate Your Existing Logseq Graph
• Configuration and Usage
• Development Guide and Contribution Guidelines
• Changelog

Build backend and frontend

1. Clone the repository
2. Install frontend dependencies and run cd frontend/looksyk, npm install, ng serve
3. Install backend dependencies and run cd backend and cargo run
4. The application is now available at http://localhost:4200 (frontend) and http://localhost:8989 (backend)

Build electron app

1. Change into the application-wrapper directory cd application-wrapper
2. Install electron dependencies npm install
3. Build the electron app npm run package
4. The application is now in the out folder e.g. out/looksyk-linux-x64/looksyk

Contribution Guidelines

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -am 'Add new feature').
5. Push to the branch (git push origin feature-branch).
6. Create a new Pull Request.