sam-potter / sweat-token

Sweat Token code and resources - Sweat Equity Vault for DAOs

Sweat Token

Sweat token help startups create an early stage cap table for sweat equity.

In other words sweat token is the early stage governance token that is gradually and transparently issues based on merits.

Repo Structure

 ├─ frontend - "ReactJs Progressive Web App"
 │─ backend - "Nesjs middleware API"
 │─ contracts - "Solidity smart contracts"
 │─ e2e-tests - "end-to-end full stack tests"

Each of the above subdirectories has its own README file with additional information.

Progressive Web App

SporosDAO Sweat Token is a Progressive Web App (source in frontend) hosted on Netlify. It uses NestJS backend (backend dir) hosted on Heroku and Mongodb Atlas cloud database. Deployment URLs for the app below:

Purpose	Branch	Live Deployment	Admin Console
Production	main	live	admin
Development staging	dev	live	admin

Project Resources

• Product Board
• Sweat Token wiki
• Figma UX design - PM Tool
• Figma UX design - new flows
• Concepts document

Development

The following steps will build and start docker containers and services for mongodb, frontend, backend and contracts mounting on the local directory.

1. Build the development environment with docker-compose build
2. Start the development environment with docker-compose up -d
3. Check the status of services with docker-compose ps. All should be in running state. If any service is in restarting or exited state then something went wrong with the setup.

You can obtain debug logs for each container while developing with

• frontend docker-compose logs -f frontend
• backend docker-compose logs -f backend
• contracts docker-compose logs -f contracts

Gitpod

In gitpod environment, the same dev setup described above still applies.

For convenience Steps 1 & 2 are configured in .gitpod.yaml and automatically run on workspace launch.

Contributing

We welcome your contributions. To provide your code please fork the project and create a PR against the dev branch. Request at least one review from the core team. dev will be merged in main branch when we reach a relevant milestone that will be then deployed via the CI/CD pipelines.

All contributors are required to read and sign one time our Contributor License Agreement during their first Pull Request review and merge process.