Giter Club home page Giter Club logo

nodemap's Introduction

Nodemap

Introduction

Nodemap is an AI-driven SaaS platform for creating visual learning paths. It allows users to select a topic to generate a node-based map for study, drawing inspiration from visual representations similar to roadmap.sh.

Technical Stack

Backend

  • Technologies: Node.js, Nest.js
  • AI Integration: OpenAI library for content generation.
  • Job Queueing: Redis with Nest.js BullMQ for managing background tasks.

Frontend

  • Technologies: React with Vite.js or Next.js
  • Visualization: d3.js for force-directed graph representations.
  • UI Components: @shadcn/ui for customizable UI elements.

Features

  1. Personal Roadmaps: Users can generate, customize, and track progress on their learning paths, marking topics as "Completed," "In Process," or "Done."
  2. Sharing Functionality: Enables users to share their personal roadmaps.
  3. Curated Roadmaps: Access to a list of popular roadmaps created by the community.

Setup

  1. Clone Repository: git clone https://github.com/effuone/nodemap.
  2. Install Dependencies: Run yarn install in both API and Web directories.
  3. Environment Configuration: Rename .env.example to .env in both api and web directories to update it with your development settings.
  4. Prepare services: Run docker-compose -f docker-compose.dev.yml up -d to run a Docker container with PostgreSQL and Redis databases.
  5. Apply migrations: Run npx prisma db push in API directory to apply Prisma migrations.
  6. Start application: Execute yarn start:dev in API directory and "yarn dev" in web directory to launch the application.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.