Skip to content

asusoda/platform

Repository files navigation

This project provides a modular internal API and Discord bots for the Software Developers Association (SoDA) at ASU. The server side is developed using Flask, handling API requests, Discord bot interactions, and data management across all modules.

Directory

Getting Started

Prerequisites

  • Podman and podman-compose
  • Make

Development Setup

  1. Clone the repository:

    git clone https://github.com/asusoda/soda-internal-api.git
    cd soda-internal-api
  2. Configure environment variables:

    # Copy the template environment file
    cp .env.template .env
    
    # Edit the .env file with your configuration values
    # This includes API keys, Discord bot token, etc.
  3. Start the development environment:

    make dev

That's it! The application will be available at:

Common Commands

# Start development environment (with logs)
make dev

# Start services in background
make up

# Stop services
make down

# View logs
make logs

# Check container status
make status


### Customizing Deployment

# Open shell in API container
make shell

# Build images
make build

# Deploy to production
make deploy

Contributing

  1. Fork the repository
  2. Create a 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

Contact

For any questions or feedback, please reach out to [email protected]

Contributors 12