🌽 maize

a daily standup tool

Installation

1. Fork and clone the repository:

git clone https://github.com/you/maize.git
cd maize

2. Install dependencies:

npm install

3. Set up environment variables:

cp .env.example .env

4. Start Convex development server:

npx convex dev

6. Start the development server in another tab:

npm run dev

Configuration

Prerequisites

• Node.js (v20 or higher)
• npm
• A Convex account (for backend functionality)
• An Auth0 account (for authentication)

Backend Setup

1. Convex Setup

   • Create a new project in Convex
   • Get your project ID from the Convex dashboard
   • Login to Convex:

     convex login

   • Set up Convex environment variables:
   • Go to your Convex dashboard: https://dashboard.convex.dev
   • Navigate to Settings > Environment Variables
   • Add the following variables:
     • AUTH0_DOMAIN - Your Auth0 domain
     • AUTH0_CLIENT_ID - Your Auth0 client ID

2. Auth0 Setup

   • Create a new application in Auth0
   • Set the following in your Auth0 application settings:
     • Allowed Callback URLs: http://localhost:3000 (development) and your deployment URL
     • Allowed Logout URLs: http://localhost:3000 (development) and your deployment URL
     • Allowed Web Origins: http://localhost:3000 (development) and your deployment URL
   • Get your Auth0 domain and client ID
   • Update your .env file with the Auth0 credentials:

     VITE_AUTH0_DOMAIN=your_auth0_domain
     VITE_AUTH0_CLIENT_ID=your_auth0_client_id

Deployment

Option 1: Netlify Deployment

The easiest way to deploy your frontend is using Netlify:

1. Push your code to a Git repository
2. Connect your repository to Netlify
3. Add the environment variables
4. Configure the build settings:
   • Build command: npx convex deploy --cmd 'npm run build'
   • Publish directory: dist
5. Deploy!

Option 2: Self-hosted Docker Deployment

You can also self-host your frontend using Docker:

1. Make sure your .env is populated with the correct credentials.

2. Build the Docker image:

docker build -t your-app-name .

1. Run the container:

docker run -p 80:80 your-app-name

The Docker setup includes:

• Multi-stage build for smaller image size
• Nginx for serving static files
• Optimized caching and compression
• Security headers
• Health check endpoint

Development

• npm run dev - Start development server
• npm run build - Build for production
• npm run typecheck - Run TypeScript type checking

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

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