Merge pull request #31 from OscarCasadoLorenzo/develop

v1.2.0

.github/CODE_OF_CONDUCT.MD

@@ -0,0 +1,55 @@
+# PDFProView Project Code of Conduct
+
+## Overview
+
+Welcome to the PDFProView project! We are committed to fostering a diverse, inclusive, and collaborative community. This Code of Conduct outlines our expectations for all contributors, maintainers, and participants in our open-source project. Please read and adhere to these guidelines to ensure a positive and respectful environment for everyone.
+
+## Our Pledge
+
+In the spirit of open source and collaboration, we, as contributors and maintainers, pledge to make participation in our project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Expected Behavior
+
+We encourage all contributors to:
+
+1. **Be Respectful:** Treat everyone with respect and kindness. Respectful and constructive communication is essential for collaboration.
+
+2. **Be Inclusive:** Embrace diversity and be inclusive of different perspectives and experiences. We welcome contributions from people of all backgrounds.
+
+3. **Be Collaborative:** Work together in a cooperative and collaborative manner. Encourage and support each other to achieve common goals.
+
+4. **Be Open-minded:** Be open to new ideas and approaches. Be willing to learn from others and share your knowledge.
+
+5. **Be Considerate:** Be considerate of others' time, efforts, and opinions. Avoid unnecessary disruptions and use resources responsibly.
+
+## Unacceptable Behavior
+
+Unacceptable behavior includes, but is not limited to:
+
+1. **Harassment:** Any form of harassment, intimidation, or discrimination is not tolerated. This includes offensive comments, verbal or written abuse, and unwelcome advances.
+
+2. **Trolling and Inflammatory Remarks:** Deliberate attempts to disrupt discussions, provoke emotional responses, or escalate conflicts are not acceptable.
+
+3. **Personal Attacks:** Critique ideas, not individuals. Personal attacks, insults, or any form of unwarranted criticism are not allowed.
+
+4. **Discrimination:** Discrimination based on age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation is not tolerated.
+
+## Reporting Violations
+
+If you witness or experience behavior that violates this Code of Conduct, please report it promptly by contacting the project maintainers at oscarcl.work@gmail.com. All reports will be treated confidentially.
+
+## Enforcement
+
+Violations of this Code of Conduct may result in corrective actions, ranging from a warning to permanent expulsion from the project, as deemed necessary by the project maintainers. We are committed to ensuring a safe and inclusive environment for everyone.
+
+## Credits
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
+
+## Scope
+
+This Code of Conduct applies within all project spaces, including but not limited to GitHub repositories, project mailing lists, and other communication channels related to the project.
+
+By participating in the PDFProView project, you agree to abide by this Code of Conduct.
+
+Thank you for your commitment to creating a welcoming and inclusive community!

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,58 @@
+---
+name: 'Bug Report'
+about: 'Report an issue to help the project improve.'
+title: '[Bug]'
+labels: 'Type: Bug'
+---
+
+# **Bug Report**
+
+## **Describe the bug**
+
+<!-- A clear and concise description of what the bug is. -->
+
+### **To Reproduce**
+
+<!-- Steps to reproduce the error:
+(e.g.:)
+1. Use x argument / navigate to
+2. Fill this information
+3. Go to...
+4. See error -->
+
+<!-- Write the steps here (add or remove as many steps as needed)-->
+
+1.
+2.
+3.
+4.
+
+---
+
+### **Expected behaviour**
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+---
+
+### **Media prove**
+
+<!-- If applicable, add screenshots or videos to help explain your problem. -->
+
+---
+
+### **Your environment**
+
+<!-- use all the applicable bulleted list elements for this specific issue,
+and remove all the bulleted list elements that are not relevant for this issue. -->
+
+- OS: <!--[e.g. Ubuntu 5.4.0-26-generic x86_64 / Windows 1904 ...]-->
+- Node version:
+- Npm version:
+- Browser name and version:
+
+---
+
+### **Additional context**
+
+<!-- Add any other context or additional information about the problem here.-->

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,26 @@
+---
+name: 'Feature Request'
+about: 'Suggest an idea or possible new feature for this project.'
+title: '[Feature]'
+labels: 'Type: Feature'
+---
+
+# **Feature Request**
+
+## **Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## **Describe the solution you'd like**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+## **Describe alternatives you've considered**
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
+
+### **Additional context**
+
+<!-- Add any other context or additional information about the problem here.-->
+
+-

.github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+## Description
+
+<!--- Describe your changes in detail -->
+
+## Related Issue
+
+<!--- Please link to the issue here: -->
+<!--- If there is no related issue, please create one here: -->
+<!--- https://github.com/OscarCasadoLorenzo/PDFProView/issues/new/choose -->
+
+## Motivation and Context
+
+<!--- Why is this change required? What problem does it solve? -->
+
+## How Has This Been Tested?
+
+<!--- Please describe in detail how you tested your changes. -->
+
+## Screenshots (if appropriate):

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "trailingComma": "none",
+  "semi": false
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "conventionalCommits.scopes": ["PDFProView"],
+  "cSpell.words": ["chakra"],
+  "editor.formatOnSave": true
+}

CONTRIBUTING.MD

@@ -0,0 +1,104 @@
+# Contributing
+
+First off, thanks for taking the time to contribute ❤!
+
+PDFProView in early development (prototyping) stage, the codebase hasn't been optimized yet. It is gradually being refactored it, changing and breaking some things, so you might encounter a lot of code conflicts.
+
+## Reporting Guidelines
+
+### 🐞 Reporting Bugs or Problems
+
+If you've identified a bug, encountered an issue, or stumbled upon a problem, we appreciate your diligence in bringing it to our attention. Before diving into the fix, please create an issue detailing the problem. This allows for discussion, collaboration, and ensures that efforts are coordinated.
+
+#### How to Report a Bug:
+
+- Go to the [Issues](https://github.com/OscarCasadoLorenzo/PDFProView/issues) section.
+- Click on `New Issue`
+- Select the `Bug Report` template.
+- Provide a detailed description, steps to reproduce, and any relevant information.
+
+### 💡 Proposing Ideas or Enhancements
+
+Have a brilliant idea or an enhancement suggestion? Fantastic! Let's discuss it first to align with the project's goals and ensure it's the right fit. Share your thoughts by creating an issue and initiating a conversation.
+
+#### How to Propose an Idea:
+
+- Navigate to the [Issues](https://github.com/OscarCasadoLorenzo/PDFProView/issues) section.
+- Click on `New Issue`
+- Select the `Feature Request` template.
+- Clearly outline your idea, its benefits, and any potential challenges.
+
+## How to contribute
+
+If you want to implement some changes into this project check the next steps for it:
+
+### Repository setup
+
+After a review, I will merge the changes into the project, if the changes are beneficial.
+
+1.  Prerequisites:
+
+- Node.js version: >= `v18.0.0`
+- npm version: >= `v9.0.0`
+
+  🔧 You can use tools like **nvm** to install and manage multiple Node versions
+
+- Check or setup your git locally (for this project) or globally and set your `user.email` and `user.name`:
+
+  ```bash
+  git config --global user.name "FirstName LastName"
+  git config --global user.email "email@gmail.com"
+  ```
+
+2. Download the project to your local computer:
+
+```
+git clone https://github.com/OscarCasadoLorenzo/PDFProView.git
+```
+
+3. Install the dependencies and start dev server:
+
+```bash
+cd /PDFProView
+npm install -D --force
+npm run dev
+```
+
+To build the project for your current platform, run this command:
+
+```bash
+npm run build
+```
+
+### Issues, Branches & Pull requests
+
+#### ⚠ Before contributing
+
+Create a new issue or a discussion and describe the feature / fix / changes you want to implement so we can discuss it first.
+
+1. **Fork the repository**
+
+   In the upper right corner of the [repository main page](https://github.com/OscarCasadoLorenzo/PDFProView), find the `Fork` button. Click on it.
+
+2. **Clone your fork locally**
+
+   ```bash
+   git clone https://github.com/<your-username>/PDFProView.git
+   ```
+
+3. **Create a new branch based on the issue**
+
+4. **Implement your changes**  
+   ❗ This repository follows the [Conventional Commits](https://www.conventionalcommits.org/) specification.
+
+5. **Create and submit the Pull Request**
+
+   Visit your forked repository on GitHub. Click on the `Pull Requests` tab, then the `New Pull Request` button. GitHub will guide you through the process of creating a pull request to the original repository.  
+   📑Do not forget to link the associated issue, for example: "Closes #1234"
+
+6. **Enjoy your work 😎**  
+   When a Pull Request is merged into develop branch you will be added in <u>contributors list</u>.
+
+## 📚 Additional Resources
+
+- [PDFProView Kanban Board](https://github.com/users/OscarCasadoLorenzo/projects/10)

README.md

@@ -1,30 +1,29 @@
-# React + TypeScript + Vite
+# [PDFProView](https://oscarcasadolorenzo.github.io/PDFProView/)
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+PDFProView is an open-source project that harnesses the power of React and the pdfjs-dist library to deliver a versatile and customizable PDF viewing experience. Whether you're building an application that requires seamless PDF integration or you're a developer looking for a robust PDF viewer, PDFProView has you covered.
 
-Currently, two official plugins are available:
+## Features
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- **React-Powered:** Utilizes the flexibility and efficiency of React to create a dynamic and responsive PDF viewer.
 
-## Expanding the ESLint configuration
+- **Customizable UI:** Tailor the user interface to fit your application's design and branding.
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+- **Versatile Navigation:** Navigate through PDF documents with ease using intuitive controls.
 
-- Configure the top-level `parserOptions` property like this:
+- **Zoom and Pan:** Zoom in and out of pages, and pan across the document for a closer inspection.
 
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
-```
+- **Page Navigation:** Quickly jump to specific pages or scroll through the document seamlessly.
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+- **Text recognition:** Perform text searches within PDF documents for quick and efficient information retrieval.
+
+## Contributing
+
+We welcome contributions to PDFProView! If you have suggestions, find bugs, or want to add new features, please check out our [Contributing Guidelines](https://github.com/OscarCasadoLorenzo/PDFProView/blob/develop/CONTRIBUTING.MD).
+
+## License
+
+PDFProView is released under the [MIT License](https://opensource.org/about/).
+
+---
+
+Thank you for choosing PDFProView! We hope it enhances your PDF viewing experience. Feel free to explore the code, contribute, and make it even better. Happy coding! 📄🚀

index.html

@@ -2,9 +2,20 @@
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
-    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <link
+      rel="icon"
+      type="image/svg+xml"
+      href="/logoDark.svg"
+      media="(prefers-color-scheme: light)"
+    />
+    <link
+      rel="icon"
+      type="image/svg+xml"
+      href="/logoLight.svg"
+      media="(prefers-color-scheme: dark)"
+    />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Vite + React + TS</title>
+    <title>PDFProView</title>
   </head>
   <body>
     <div id="root"></div>