char.build Subproject Template

This template is designed specifically for creating new subprojects for the char.build domain.

How to Use This Template

  1. Fork/remix this template to create a new subproject
  2. Update the config object in http.tsx:
    • Change the name to your subproject's name
    • Set the basePath to the URL path you want (e.g., "/myapp")
  3. Customize the content in the page components
  4. Deploy your subproject and get the endpoint URL
  5. Add your subproject to the main char.build project (see below)

Adding Your Subproject to char.build

After deploying your subproject, you'll need to add it to the main char.build project:

  1. Get your subproject's endpoint URL after deployment
    • It will look like: https://dcm31--[long-identifier].web.val.run
  2. Ask the char.build administrator to add your subproject to the proxies.tsx file:
// Entry to add to char.build's proxies.tsx { pattern: '/yourpath', // This must match your subproject's basePath target: 'https://dcm31--your-endpoint-id.web.val.run', name: 'Your Subproject Name' }

Features of This Template

  • Automatic path handling for both direct and char.build access
  • Simple page routing with multiple example pages
  • Navigation between pages and back to the main char.build site
  • Styling that matches the char.build aesthetic
  • Clear instructions for integration

File Structure

  • http.tsx - Main entry point with config and all page components
  • README.md - This documentation file

Customizing Your Subproject

This template is designed to be a starting point. Feel free to:

  • Add more pages by extending the routing in the main App component
  • Customize the styles to match your specific subproject's needs
  • Add more links to the navigation menu
  • Include additional files or components as needed

Support

If you need help with integrating your subproject with char.build, contact the char.build administrator.