laserfiche-sharepoint-integration

Summary

This project, built with React, contains 3 SharePoint we that can be used to communicate with Laserfiche. To learn more about web parts, consult Microsoft's documentation for Using them and Building them.

Prerequisites

See .github/workflows/main.yml for Node and NPM version used.

Change Log

See CHANGELOG here.

Contribution

We welcome contributions and feedback. Please follow our contributing guidelines.

---

one-time setup

• clone this repo
• run npm install

To run locally

• Ensure that you are at the solution folder
  • run npm run gulp-trust-dev-cert
  • Replace REPLACE_WITH_YOUR_SHAREPOINT_SITE in serve.json with your sharepoint site
  • run npm run serve
    • this should open up a window in the browser called a SharePoint workbench.
  • To use a.clouddev.laserfiche.com: Open browser dev tools and go to site Local Storage: set 'spDevMode' to true

To build solution for development/testing changes

• npm run build
• npm run package
• this should result in the creation of a file with the path /sharepoint/solution/laserfiche-sharepoint-integration.sppkg from the root folder.
• reference the Admin Documentation for instructions on how to use the solution file to test your changes to the WebParts in SharePoint Sites.

To build solution for production

• npm run build --ship
• npm run package --ship
• This will create the solution file at /sharepoint/solution/laserfiche-sharepoint-integration.sppkg.
• Once you've built and packaged the solution file, you can upload it in the SharePonit admin center.

To build documentation locally

1. follow the instructions here to install jekyll and bundler
   • if any dependency installation fails, try downloading the package manually.
   • navigate to the download directory
   • run gem install problematic-dependency-name, where the last word is replaced by the package you downloaded manually
   • retry installing the original package now that its dependency is installed.
2. run bundle install to install all the dependencies needed to serve
3. run bundle exec jekyll serve to serve the documentation.
4. Open localhost:4000 in a browser.