This project was bootstrapped with Create React App.

Development Principles

Redux

To simplify contributions to this frontend tool, the project uses Redux in conjunction with React. Keeping reducers and actions seperate from presentational logic will ideally help developers who aren't as presentation-focused contribute to parts and those who are more focused on the layout can contribute to others.

File Structure

The file structure at the root level has a directory for each sub-module of the application, as well as a common directory for anything that is shared by multiple sub-modules. At a minimum, each of the sub-module directories should have this structure:

.
├── submodule_a
│   ├── actions
│   ├── components
│   ├── constants
│   ├── containers
│   ├── reducers
│   └── tests
├── submodule_b
│   ├── actions
│   ├── components
│   ├── constants
│   ├── containers
│   ├── reducers
│   └── tests
└── ...

The name of each sub-directory aptly describes the segment of Redux's ecosystem it contains.

Building the Project

If you want to help develop the Valorant Pugfinder frontend, you should first install NodeJS and Yarn. Your system must also have an install of Python running. Then it's just a simple matter of navigating to the root directory and running

yarn install

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.