DefiFundr Setup Guide

This guide will help you set up your development environment for contributing to DefiFundr.

Prerequisites

Before you begin, make sure you have the following installed:

Go (version 1.21 or higher)
Docker and Docker Compose
Git
Solidity Compiler (for smart contract development)
Node.js and npm (for smart contract tools)

Initial Setup

Clone the repository:

git clone https://github.com/your-org/defifundr.git
cd defifundr

Install required development tools:
```
make install-tools
```
This command installs:
- air - Live reload for Go applications
- goose - Database migration tool
- sqlc - SQL compiler for Go
- mockgen - Mock generation for testing
- golangci-lint - Linting tool for Go
Set up environment variables:
```
cp .env.example .env
```
Edit the .env file to configure your development environment. At minimum, set:
- DB_SOURCE - Database connection string
- JWT_SECRET - Secret key for JWT tokens
- ETHEREUM_RPC_URL - Ethereum node URL

Database Setup

Start a PostgreSQL container:
```
make postgres
```
Create the database:
```
make createdb
```
Run migrations to set up the schema:
```
make migrate-up
```
(Optional) Seed the database with test data:
```
make seed
```

Smart Contract Setup

Generate Go bindings for smart contracts:
```
make gencontract
```
This compiles the Solidity contracts and generates Go interfaces.

Running the Application

Start all required Docker containers:
```
make docker-up
```
Generate SQL code:
```
make sqlc
```

Start the API server:

# Option 1: Standard mode
make server

# Option 2: Hot reload mode (recommended for development)
make air

Generate API documentation:
```
make swagger
```
Access the Swagger UI at http://localhost:8080/swagger/index.html

Verifying Your Setup

Check that the database is running:
```
make docker-ps
```
Verify database migrations are applied:
```
make migrate-status
```
Run tests to ensure everything is working:
```
make test
```

Development Workflow

Once your environment is set up, follow this workflow for development:

Create a feature branch:
```
git checkout -b feat/your-feature-name
```
Make your changes and write tests.
Run linting:
```
make lint
```
Run tests:
```
make test
```
Generate any updated documentation:
```
make swagger
```
Commit your changes using conventional commits format.
Submit a pull request following the guidelines in CONTRIBUTING.md.

Troubleshooting

Database Connection Issues

If you encounter database connection errors:

# Check if PostgreSQL container is running
make docker-ps

# View PostgreSQL logs
make dockerlogs

# Restart the PostgreSQL container
make docker-restart

Smart Contract Compilation Errors

If smart contract generation fails:

Ensure solc (Solidity Compiler) is correctly installed
Check contract syntax for errors
Verify the correct paths in the Makefile

Go Module Issues

If you encounter Go module issues:

# Clear Go module cache
go clean -modcache

# Update dependencies
go mod tidy

Additional Resources

Getting Help

If you need further assistance, refer to:

Project-specific documentation in the docs directory
Open an issue on GitHub
Contact the project maintainers

FilesExpand file tree

SETUP.md

Latest commit

History