initial commit

Author: justinjung04

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to WebViewer UI
+
+## Issues
+1. Check existing issues (open/closed) to avoid duplicates.
+2. Be clear about what the problem is.
+3. Make sure to paste error output or logs.
+4. Code snapshot or demos on online code editor will be very helpful.
+
+## Pull requests
+1. Fork the repository.
+2. Create a branch from `master`.
+3. Update the source code using style guides described below.
+4. Lint your code with `npm run lint`.
+5. Commit and push the changes with descriptive messages.
+6. Create a pull request to `master`.
+
+\* Please note that all pull requests should be tied to an issue, and all but the most trivial pull requests should be discussed before hand.
+
+## Style guides
+- Tab indentation (size of 2 spaces).
+- `'` instead of `"`.
+- Curly braces for block statements.
+- 1TBS brace style.
+- Semicolon at the end of each statement.
+- Object shorthand for ES6.
+- Parenthesis around arrow function argument.
+- Minimum line breaks.
+- No `use strict`.

LICENSE

@@ -0,0 +1,2 @@
+Copyright 2018 PDFTron Systems Inc. All rights reserved.
+WebViewer React UI project/codebase or any derived works is only permitted in solutions with an active commercial PDFTron WebViewer license. For exact licensing terms please refer to your commercial WebViewer license. For use in other scenario, please contact sales@pdftron.com

README.md

@@ -0,0 +1,59 @@
+# WebViewer UI
+
+WebViewer UI sits on top of [WebViewer](https://pdftron.com/webviewer), a powerful JavaScript-based PDF Library that's part of the [PDFTron PDF SDK](https://pdftron.com). Built in React, WebViewer UI provides a slick out-of-the-box responsive UI that interacts with the core library to view, annotate and manipulate PDFs that can be embedded into any web project.
+
+![WebViewer UI](./assets/webviewer-ui.png)
+
+This repo is specifically designed for any users interested in advanced customizations. With the source code access, it gives developers full control to customize & style the UI, build custom controls & logic, integrate into workflows, or build a UI from scratch.
+
+## Initial setup
+
+To work with this repo, you must download the latest WebViewer and link it to this repo.
+
+1. Download [WebViewer](https://pdftron.com/webviewer).
+2. Follow steps from [forking WebViewer](https://pdftron.com/documentation/web/guides/advanced-customization/forking-and-setting-up-the-sync).
+
+Now you can navigate to `WebViewer/lib/ui` and run the commands to install, run and build.
+
+## Install
+
+```
+npm install
+```
+
+## Run
+
+```
+npm start
+```
+
+## Build
+
+```
+npm run build
+```
+
+## Project structure
+
+```
+src/
+  apis/            - APIs exposed in myWebViewer.getInstance()
+  components/      - React components
+  constants/       - JavaScript or CSS constants
+  core/            - APIs from the Core
+  event-listeners/ - Listeners for the Core events
+  helpers/         - Reused functions
+  redux/           - Redux files for state managing
+```
+
+## API documentation
+
+See [API documentation](https://pdftron.com/documentation/web/guides/ui/apis).
+
+## Contributing
+
+See [contributing](./CONTRIBUTING.md).
+
+## License
+
+See [license](./LICENSE).