Skip to content

owdproject/owd-app-projects

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

45 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Projects module for OWD Client

The perfect module to show your portfolio in a folder-like way

OWD Projects module demo

Become a Patron Join us on Discord

Demo

Try it out, just open the terminal and type "projects"

Features

  • Show projects in a folder
  • Open project link in a new tab
  • Open project link in an iframe window (optional)

Quick install

  • Move to your client folder, then
    # Install this module with Npm
    npm install https://github.com/hacklover/owd-app-projects
    
    # Or using Yarn
    yarn add https://github.com/hacklover/owd-app-projects
    
  • Define this module in owd-client/client.extensions.ts
    import AboutModule from "@owd-client/core/src/modules/app/about";
    import DebugModule from "@owd-client/core/src/modules/app/debug";
    import ProjectsModule from "owd-app-projects/client";
    
    export default {
      app: {
        modules: [
          AboutModule,
          DebugModule,
          ProjectsModule,
        ]
      },
      ...
  • Copy the content of the client/config folder into owd-client/config

Configuration

Add new projects

Edit the config/projects/config.json file that you copied during the installation by adding all the projects you want.

Show projects in an iframe

Add to the project configuration the "window" property to define the window name to open (for example WindowProjectACME) when you click on it. It must correspond to an existing window that uses the component.

An example of an iframe window is available in this module (WindowProjectACME.vue).

"example": {
  "title": "ACME",
  "name": "ACME",
  "url": "https://acme.gov",
  "target": "_blank",
  "window": "WindowProjectACME",
  "icon": "data:image/png;base64,iVB...",
  "year": "1988",
  "end": 0,
  "comingSoon": false,
  "inactive": false,
  "hidden": false
}

Compatibility

  • Open Web Desktop client v2.0.0-beta.1

License

This project is released under the MIT License