Gathering detailed insights and metrics for cra-template-overwolf-typescript-redux
Gathering detailed insights and metrics for cra-template-overwolf-typescript-redux
npm install cra-template-overwolf-typescript-redux
Typescript
Module System
Min. Node Version
Node Version
NPM Version
75
Supply Chain
99
Quality
76.2
Maintenance
100
Vulnerability
99.6
License
TypeScript (85.44%)
CSS (10%)
JavaScript (2.62%)
HTML (1.94%)
Total Downloads
8,233
Last Day
18
Last Week
225
Last Month
293
Last Year
1,693
56 Stars
128 Commits
18 Forks
3 Watching
4 Branches
8 Contributors
Minified
Minified + Gzipped
Latest Version
3.2.1
Package Id
cra-template-overwolf-typescript-redux@3.2.1
Unpacked Size
5.23 MB
Size
5.13 MB
File Count
117
NPM Version
10.2.5
Node Version
20.10.0
Publised On
15 Jan 2024
Cumulative downloads
Total Downloads
Last day
500%
18
Compared to previous day
Last week
1,150%
225
Compared to previous week
Last month
161.6%
293
Compared to previous month
Last year
1.9%
1,693
Compared to previous year
2
This is the official Overwolf Modern React Boilerplate template for Create React App.
OMRB is a free and open source opinionated boilerplate based on React that helps developers create fast, modular and modern overwolf app.
Use a Modern Stack for Every App. Create a uniform workflow for you and your team without ejecting the Create React App code.
Internationalization. Support for multiple languages without having to change code.
Performance Is Baked In. Custom hooks with functions and variables memoized for common uses in overwolf development.
Build. Folders and structure ready for use in the overwolf store.
CI/CD continuous development, continuous testing, continuous integration, continuous deployment
To use this template, add --template overwolf-typescript-redux
when creating a new app.
For example:
1npx create-react-app my-app --template overwolf-typescript-redux 2 3# or 4 5yarn create react-app my-app --template overwolf-typescript-redux
For more information, please refer to:
this version the project is configured and ready to test with the Hearthstone game, you can use the template, compile and test without modifying anything to understand the development flow.
Folder-by-type only works on small-scale projects. Folder-by-feature is superior in the majority of cases, is better due to its scalability, stands out in high modularity and cohesion. It allows us to play with the components' scope.
1. 2|--- public 3|---- # essencial files for overwolf store 4|--- src 5| |--- app/ 6| |----# global and shared components 7| |----lib/ 8| |----# global and shared functions 9| |--- components/ 10| |----# components that are not part of the application's business rule and can be reused in other features 11| |--- features/ 12| |----# features that are part of the application's business rule and can be reused in other features 13| |--- screens/ 14| |----# screens that are part of each entry point of the application from the ovewolf manifest 15| |--- locales/ 16| |-----------de/**/*.json 17| |-----------de/index.ts 18| |-----------en/**/*.json 19| |-----------en/index.ts 20| |-----------es/**/*.json 21| |-----------es/index.ts 22| |-----------fr/**/*.json 23| |-----------fr/index.ts 24| |-----------it/**/*.json 25| |-----------it/index.ts 26| |-----------ko/**/*.json 27| |-----------ko/index.ts 28| |-----------pl/**/*.json 29| |-----------pl/index.ts 30| |-----------pt/**/*.json 31| |-----------pt/index.ts 32| |-----------ru/**/*.json 33| |-----------ru/index.ts 34| |-----------tr/**/*.json 35| |-----------tr/index.ts 36| |-----------index.ts 37| |--- index.tsx 38| |--- overwolf.dev.mock.ts 39| |--- react-app-env.d.ts 40| |--- setupTests.ts 41|--- .gitignore 42|--- LICENSE 43|--- README.md 44|--- package-lock.json 45|--- package.json 46|--- tsconfig.json 47.
In overwolf it is not possible to install plugins to debug the code, so the alternative is to use something remote to debug an injected code.
1cd overwolf-modern-react-boilerplate 2npm run start-remote-server
whenever you want to debug your app store, just remember to use the remote redux dev tools + the bridge server
you need to create an optimized version of your code and the correct structure before sending it to the overwolf store. Overwolf Doc: How to submit an app
Compile
1#Change into directory 2cd overwolf-modern-react-boilerplate 3npm run build:overwolf
Edit Changelog
To make it easier for users, contributors and overwolf team to see precisely what notable changes have been made between each release (or version) of the project.
Send .zip (if it is the first time you are sending the app, you need to send the .zip file to the overwolf team, so that they can create the app in the store)
|--- build/**/.**
1$ vi project-root/CHANGELOG.md
throughout the development cycle testing or releasing small updates can become a bit tedious, so there is also a github action setting when you generate a new project, you don't actually need to do any extra steps if you use github, this means that whenever you add valid code to the main branch, then an automatic github action will do all the compiling and packaging steps automatically.
About CI/CD File.yml
Name | Description | type |
---|---|---|
PRE_RELEASE_CHANNEL | overwolf channel id | number |
Note: Test Channel IDs from overwolf-cli Several commands work with test channels. While we plan to accept the channel's name, for now, we expect to receive the channel ID as the argument. You can find the channel's ID in the page URL of the channel in the Dev Console.
Name | Description | type |
---|---|---|
OW_CLI_EMAIL | overwolf dev email | string |
OW_CLI_API_KEY | overwolf dev api key | string |
Check out some screenshots of what github actions looks like:
Contributions, issues and feature requests are welcome!
If you are using OMRB in your project, please let me know! I'll be happy to list it here.
A map for Fortnite Battle Royale.
A tool to help you manage economy in the cs2.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
Reason
packaging workflow detected
Details
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
6 existing vulnerabilities detected
Details
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
Reason
Found 4/16 approved changesets -- score normalized to 2
Reason
2 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-01-13
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More