Source Cooperative

A data publishing utility that allows trusted organizations and individuals to share data using standard HTTP methods.

Project Status

Source Cooperative is operational and available at https://source.coop, providing access to over 5PB of data.

Development Setup

Prerequisites

• Node.js 22
• Docker and Docker Compose
• Git
• AWS CLI (for local DynamoDB interaction)

Local Development

1. Clone the repository
2. Copy .env.example to .env.local
3. Install dependencies: npm install
4. Start development server: npm run dev

Database Setup

The application requires a DynamoDB instance for data storage. Docker Compose is used to run DynamoDB locally for development:

# Start DynamoDB and DynamoDB Admin
docker compose up

This will start:

• DynamoDB Local on port 8000
• DynamoDB Admin UI on port 8001 (accessible at http://localhost:8001)
• Bootstrap script that automatically initializes tables if they don't exist

The bootstrap script (init-db service) will:

1. Run automatically when tables are not found
2. Create all required DynamoDB tables
3. Populate sample data for development
4. Can be forced to reset tables by setting the RESET_TABLES environment variable:

# Force reset and reinitialize tables
RESET_TABLES=true docker compose up

Development Environment

• Local DynamoDB
• DynamoDB Admin UI
• Environment variables in .env.local

Contributing

See CONTRIBUTING.md for detailed information about contributing to the project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Available Scripts

# Development
npm run dev         # Start development server
# npm run build       # Build production bundle
# npm run start      # Start production server
npm run lint       # Run ESLint
npm run type-check # Run TypeScript checks

Troubleshooting

Common Issues:

1. Build errors

   • Ensure all dependencies are installed
   • Clear .next directory and rebuild

   rm -rf .next
   npm run build
   

2. Environment variables not working

   • Verify .env.local exists and is properly configured
   • Restart the development server

3. Type errors

   • Run npm run type-check to identify issues
   • Ensure types are properly imported

Additional Resources

• Next.js Documentation
• Radix UI Documentation
• TypeScript Documentation

Copyright 2024 Radiant Earth