LearnForge - Learning Goal Management and Logging App

LearnForge is a comprehensive app that empowers you to manage and track your learning goals with ease. This README file provides an overview of LearnForge, its features, and instructions for getting started. To install the app, refer to the Installation Guide.

Table of Contents

• LearnForge - Learning Goal Management and Logging App
  • Table of Contents
  • Features
  • Demo
  • Installation Guide
  • Getting Started
    • Tauri (Windows)
    • Electron (Linux)
      • Extras
    • Browser Only (Any Platform)
  • Contributing
  • Feedback and Issues
  • License
  • Frameworks

Features

• Skill Tree Visualizer: LearnForge features a captivating "skill tree" interface, reminiscent of tech trees in games like Stellaris. This visual representation allows you to organize and track your acquired skills under different categories, such as software, hardware, machine learning, and more.

• Goal Management: With LearnForge, you can define your goals for skill acquisition. The app enables you to track progress and mark completed goals, facilitating efficient goal management.

• Logging Progress: Keep a record of your learning journey by logging your progress. LearnForge allows you to add notes, milestones, and achievements in markdown format, providing a comprehensive overview of your process.

• Category-based Organization: Categorize your skills based on different domains, such as programming languages, frameworks, or specific areas of expertise. This categorization simplifies navigation and enables you to focus on specific skill sets.

• Cross-Platform Compatibility: LearnForge is built using Tauri, React, and TypeScript (ts). This technology stack ensures cross-platform compatibility, allowing you to run the app locally on various operating systems.

Demo

Installation Guide

Windows and Linux is supported with binary executables in Releases. Currently, Linux only supplies the AppImage format (other formats coming soon).

Getting Started

Tauri (Windows)

To run LearnForge locally on your machine, follow these steps:

1. Install Environment: Start by installing the latest Node.js LTS and the latest Rust. Verify that your installation is successful by typing the following.

   > cargo --version
   cargo 1.77.1 (e52e36006 2024-03-26)
   > node -v
   v20.12.1
   

2. Install Tauri Prerequisites: You may need to install platform-specific webviews. This is because Tauri uses the system webview for better performance and memory-optimization. Refer to this guide to install the correct one for your platform Prerequisites.

3. Clone the Repository: Start by cloning the LearnForge repository to your local machine using the following command:

   > git clone https://github.com/zydtiger/LearnForge.git
   

4. Install Dependencies: Navigate to the project directory and install the necessary dependencies by running the following command:

   > cd LearnForge
   > yarn
   

5. Run the App: Once the installation is complete, you can launch LearnForge by executing the following command:

   > yarn tauri dev
   

6. Access LearnForge: The LearnForge app should pop up automatically with the correct setup. You can now begin managing your learning goals and exploring the skill tree interface.

   • In case something like this pops up, change the scripts:dev in package.json to vite --port=<available port> and build:devPath in src-tauri/tauri.conf.json to http://localhost:<your port>.

   error when starting dev server:
   Error: listen EACCES: permission denied ::1:1420
     at Server.setupListenHandle [as _listen2] (node:net:1880:21)
     at listenInCluster (node:net:1945:12)
     at GetAddrInfoReqWrap.doListen [as callback] (node:net:2109:7)
     at GetAddrInfoReqWrap.onlookup [as oncomplete] (node:dns:109:8)
   

7. Building the App: Once you have tested LearnForge works as expected, you may proceed to building the App yourself.

   > yarn tauri build
   

   The script automatically builds the app to src-tauri/target/.

Electron (Linux)

1. Install Environment: You only need to install the latest Node.js LTS. Verify that your installation is successful by typing the following.

   > node -v
   v20.12.1
   

2. Clone the Repository: Clone the LearnForge repository to your local machine using the following command:

   > git clone https://github.com/zydtiger/LearnForge.git
   

3. Install Dependencies: Navigate to the project directory and install the necessary dependencies by running the following command:

   > cd LearnForge
   > yarn
   

4. Run the App: Once the installation is complete, you can launch LearnForge by executing the following command:

   > yarn dev:electron
   

5. Building the App: Once you have tested LearnForge works as expected, you may proceed to building the App yourself.

   > yarn build:electron
   

   The script automatically builds the app to src-electron/target/.

Extras

To build the app in flatpak, you would need dependencies flatpak and flatpak-builder. You would also need to install the required platform, SDK, and base app using flatpak:

• org.freedesktop.Platform
• org.freedesktop.Sdk
• org.electronjs.Electron2.BaseApp

In order to find out the required version, take a look at the flatpak entry of builder config.

Browser Only (Any Platform)

1. Install Environment: You only need to install the latest Node.js LTS. Verify that your installation is successful by typing the following.

   > node -v
   v20.12.1
   

2. Clone the Repository: Clone the LearnForge repository to your local machine using the following command:

   > git clone https://github.com/zydtiger/LearnForge.git
   

3. Install Dependencies: Navigate to the project directory and install the necessary dependencies by running the following command:

   > cd LearnForge
   > yarn
   

4. Run the App: Once the installation is complete, you can launch LearnForge by executing the following command:

   > yarn dev
   

5. Building the App: Once you have tested LearnForge works as expected, you may proceed to building the App yourself.

   > yarn build
   

   The script automatically builds the app to dist/. You will only need a static file server and serve that directory to run the app as a pure webpage.

Contributing

When contributing to this repo, first fork your own repo and merge through PR. For a general guideline read Contributing Guide.

Feedback and Issues

If you encounter any issues, have suggestions for new features, or need assistance, please submit a github issue. We will get it fixed ASAP.

License

LearnForge is released under the MIT License.

Frameworks