This code is for now just released as is without a functional backend to make it work practically similar to the browser extension we have already made public.
The main intention of releasing it in its current form is to allow developers who are looking to build similar add-in to look at how we dealt with the challenges of:
- triggering checks on text inside Microsoft Word
- allowing interaction with the results along with receive context information
- replacing content through proposed alternatives.
Our ideal hope would be the creation of an open source package that will make this type of use case a "solved problem" across all browsers by pooling resources to maintain reliable algorithms for dealing with all websites out there, or at least a sizeable subset.
We hope to in the near future also release other bits including the API backend and rule editor and user dashboard that were created at https://witty.works that formed our solution for "operationalizing" inclusive langiage and consistent language within organisations. Please contact lukas.smith@witty.works if you want to support these effort in anyway, including any offers for hosting.
- Enable inspector: https://learn.microsoft.com/en-us/office/dev/add-ins/testing/debug-office-add-ins-on-ipad-and-mac
- Run
npm run ssl:config - Run
npm run build:dev - Run
npm run dev-server - Run
npm run start:desktop
More infos: https://learn.microsoft.com/en-us/office/dev/add-ins/testing/sideload-office-add-ins-for-testing
The self-signed SSL certificates used for development expire after 30 days. Run
npm run ssl:config to create new ones when needed.
Run npm run dev-server for a dev server. Run npm run start:desktop to open
Word and sideload the add-in automatically.
To run on the web, get the shareable link for a document you have access to,
then run npm run start:web -- --document https://thedocumenturl to open Word
in your default browser and sideload the add-in. If this doesn't work on the
first try, you may need to visit https://localhost:4200 first to let your
browser know to trust the self-signed certificate that is being used.
Run ng generate component component-name to generate a new component. You can
also use ng generate directive|pipe|service|class|guard|interface|enum|module.
Run npm run build:dev to build the project. The build artifacts will be stored
in the dist/ directory. Use npm run build for a production build.
Run npm run test to execute the unit tests via
Karma. Use npm run test:coverage to generate
a coverage report in /coverage.
Run npm run e2e to execute the end-to-end tests via
Protractor.
This template supports debugging using any of the following techniques:
- Use a browser's developer tools
- Attach a debugger from the task pane
- Use F12 developer tools on Windows 10
- Remove the sideloaded extension by deleting the relevant XML file in
/Users/username/Library/Containers/com.microsoft.Word/Data/Documents/wef
- Office add-in documentation
- More Office Add-in samples at OfficeDev on Github
This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
To get more help on the Angular CLI use ng help or go check out the
Angular CLI Overview and Command Reference page.