This is a ReactTS-based web application boilerplate.
The entire project is standardized and basically divided into, but not restricted, in the bellow main folders:
src: the core of the application. Stores the main files and multiple subfolders.assets: store static files, including images and vectors.components: atomified (by responsability, not code sizing) folder with the entire application componentsatomsmoleculesorganisms
contexts: all contexts, including its related parsers, types and others, are stored by folders. Each folder, represents an context. The general files are stored in root but should be avoided.hooks: hooks are abstractions of over each context, with main function of export context desired resources. Each hook is represented by a file.pages: literally store the application pages. The indexes files of this folder should be directly called into router.routers: responsible for store the main router file and its helpers.services: external resources should stored here, including error or event tracking ones.utils: general utility resources used by the entire app.
- There are an test flow of atomic designed components: organism, molecule and atom.
- There is an context and hook named as "Test" that shows how the contexts should be used. Every request, major parsers and types should be inside of the context. The hook is only an abstraction to use the context resources in an better performing way.
- To create and new context and use its hook in an page, remember to add this page's route, declared in the
main-router.tsxfile as children of context provider (created in the context file).
- Install the dependencies:
yarn; - Create environtment variables file (
.env) using the.env.templatefile as template. - Execute
yarn dev
The project will be available at http://localhost:3000
- To identify unused or unresolved imports, just run
yarn scan-dead-code.