Parker-Quinn/squid-dao-web

🦑 SQUID DAO Frontend

This is the front-end repo for SQUID DAO.

🔧 Setting up Local Development

Required:

• Node v14
• Yarn
• Git

$ git clone https://github.com/squiddaodev/squid-dao-web.git
$ cd squid-dao-web

# 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 start

The site is now running at http://localhost:3000! Open the source code and start editing!

Architecture/Layout

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