This is the front-end repo for Exodia that allows users be part of the future of Greece.
_ Note We're currently in the process of switching to TypeScript. Please read this guide on how to use TypeScript for this repository. https://github.com/OlympusDAO/olympus-frontend/wiki/TypeScript-Refactor-General-Guidelines _
Required:
$ git clone --recurse-submodules https://github.com/ExodiaFinance/exodia-frontend
$ cd olympusdao
# set up your environment variables
# read the comments in the .env files for what is required/optional
$ cp .env.example .env
# fill in your own values in .env, then =>
$ yarn
$ yarn startThe site is now running at http://localhost:3000!
Open the source code and start editing!
You can test the deployed version by doing docker-compose up --build
Faucets TODO
The app is written in React using Redux as the state container.
The files/folder structure are a WIP and may contain some unused files. The project is rapidly evolving so please update this section if you see it is inaccurate!
./src/
├── App.jsx // Main app page
├── abi/ // Contract ABIs from etherscan.io
├── actions/ // Redux actions
├── assets/ // Static assets (SVGs)
├── components/ // Reusable individual components
├── constants.js/ // Mainnet Addresses & common ABI
├── contracts/ // TODO: The contracts be here as submodules
├── helpers/ // Helper methods to use in the app
├── hooks/ // Shared reactHooks
├── themes/ // Style sheets for dark vs light theme
└── views/ // Individual Views
Olympus uses linguijs to manage translation.
The language files are located in a submodule deployed in src/locales/translations. This submodule points to the olympus translation repository
For the translations to run locally, you must pull the submodlue and compile the translations:
git submodule update --init --recursive
yarn lingui:extract
yarn lingui:compile
In order to mark text for translation you can use:
- The component in jsx templates eg.
<Trans>Translate me!</Trans> - The t function in javascript code and jsx templates.
t`Translate me`You can also add comments for the translators. eg.
t({
id: "do_bond",
comment: "The action of bonding (verb)",
})
When new texts are created or existing texts are modified in the application please leave a message in the OlympusDao app-translation channel for the translators to translate them.
You can view a list of planned feature on our Kanban. Ask @HOVOH on Discord to give you an invite link if you want to get involved.
NOTE: For big changes associated with feature releases/milestones, they will be merged onto the develop branch for more thorough QA before a final merge to master
Defenders of the code:
Only the following people have merge access for the master branch.
- Join our Discord and ask how you can get involved with the DAO!