This project was bootstrapped with Vite.
- a
git
client installed nodejs
(v18.19.0 LTS),npm
andyarn
installed- optional, but useful: an IDE (Visual Code for example)
- run
yarn
in the project directory. - run
npm run start-devnet
fot theDevnet
network. - optionally make edits to
networks
or other configurations found in newly createdindex.ts
in thesrc/config
folder.
- One can use any of the existing network setups by running one of the
npm run start-*
scripts available in thepackage.json
file. - Or, alternatively copy one of the config files ( for ex.
/src/config/config.devnet.ts
) to a new file/src/config/index.ts
In the project directory, you can run:
Runs the app in the development mode. Open http://localhost:3002 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
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.
Use the Free version of the Fontawesome Icons ( used by default ) ( no paid plan necessary )
Prepare the Pro version of the Fontawesome Icons ( a paid plan for Fontawesome is needed ) If you already have a fontawesome accessToken, you will either have to either:
- set a
.npmrc
file with only the_authToken
, without theregistry
( the.npmrc
file is already added in the.gitignore
file) - run
npm config set "//npm.fontawesome.com/:_authToken" FONT-AWESOME-PACKAGE-TOKEN
See more on Fontawesome's Using A Package Manager page.
You can learn more in the Vite documentation.
To learn React, check out the React documentation.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
One can contribute by creating pull requests, or by opening issues for discovered bugs or desired features.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request to the
development
branch