Automanic is a comprehensive template repository system designed to streamline the setup and management of software projects. It automatically determines the required file and folder structure, repository type, and settings based on user-provided specifications in a README.md file or through interactive methods. This tool provides complete automation for GitHub operations including issues, pull requests, reviews, commits, and merges, allowing developers to focus on coding rather than configuration.
Visit the interactive setup wizard: https://UniversalStandards.github.io/automanic
Follow these steps to get started with Automanic:
- Visit https://UniversalStandards.github.io/automanic
- Answer the configuration questions
- Copy the generated configuration block
- Paste it into your project's README.md
- Run the setup script
-
Clone this repository:
git clone https://github.com/UniversalStandards/automanic.git cd automanic -
Install dependencies:
For Python scripts:
pip install pyyaml
For the React web app (optional):
npm install
-
Run the interactive setup:
./scripts/interactive-setup.sh
Or use the automatic setup with your README.md:
./scripts/setup.sh
Add this configuration block to your README.md:
<!-- AUTOMANIC-CONFIG-START -->
PROJECT_TYPE: web-app
LANGUAGE: python
FRAMEWORK: fastapi
BUILD_SYSTEM: pip
DATABASE: postgresql
DEPLOYMENT: docker
CI_CD: github-actions
TESTING: pytest
LICENSE_TYPE: mit
VISIBILITY: public
<!-- AUTOMANIC-CONFIG-END -->
# Your Project Title
Your project description here...| Field | Options |
|---|---|
PROJECT_TYPE |
web-app, cli-tool, library, api, mobile-app, desktop-app, data-science, documentation |
LANGUAGE |
python, javascript, typescript, go, rust, java, cpp, c, php, ruby, swift, kotlin, scala, r |
FRAMEWORK |
react, vue, angular, express, fastapi, django, spring, gin, actix, electron, flutter, pytorch, tensorflow, none |
BUILD_SYSTEM |
npm, yarn, pip, cargo, maven, gradle, make, cmake, none |
DATABASE |
postgresql, mysql, mongodb, redis, sqlite, none |
DEPLOYMENT |
docker, kubernetes, aws, gcp, azure, vercel, netlify, heroku, none |
CI_CD |
github-actions, jenkins, gitlab-ci, circleci, travis-ci, none |
TESTING |
jest, pytest, cargo-test, junit, go-test, rspec, none |
LICENSE_TYPE |
mit, apache-2.0, gpl-v3, bsd-3-clause, unlicense, proprietary |
VISIBILITY |
public, private |
- Automatically generates folder structures based on project type
- Configures repository settings such as branch protection rules
- Creates language-specific configuration files
- Interactive Web GUI: User-friendly web interface for configuration
- CLI Walkthrough: Interactive command-line setup wizard
- README.md Template: Upload a pre-configured README.md
- Integrates with GitHub Copilot for code suggestions
- Automated code reviews and quality checks
- Smart issue labeling and assignment
- Pre-configured CI/CD workflows
- Automated testing, linting, and deployment
- Security scanning with CodeQL and Bandit
- Dependabot integration for dependency updates
- Automatic issue labeling based on content
- Automatic reviewer assignment
- PR templates with checklists
- Auto-merge for passing dependency updates
your-project/
βββ .github/
β βββ workflows/ # CI/CD workflows
β β βββ ci.yml # Continuous Integration
β β βββ deploy.yml # Deployment workflow
β β βββ auto-management.yml # Issue/PR automation
β β βββ auto-release.yml # Release automation
β βββ ISSUE_TEMPLATE/ # Issue templates
β βββ PULL_REQUEST_TEMPLATE.md
β βββ dependabot.yml # Dependency updates
βββ src/ # Source code
βββ tests/ # Unit tests
βββ docs/ # Documentation
βββ scripts/ # Automation scripts
βββ config/ # Configuration files
βββ .gitignore # Git ignore rules
βββ .editorconfig # Editor configuration
βββ README.md # Project documentation
βββ CONTRIBUTING.md # Contribution guidelines
βββ CHANGELOG.md # Version history
βββ SECURITY.md # Security policy
βββ LICENSE # License file
This repository is configured for automatic deployment to GitHub Pages.
- Go to your repository Settings
- Navigate to Pages in the left sidebar
- Under Build and deployment:
- Source: Select "GitHub Actions"
- The site will automatically deploy when you push to the
mainbranch
The GitHub Pages site will be available at: https://[username].github.io/automanic
npm install
npm run deploy- Setup Guide - Detailed setup instructions
- Configuration Reference - All available options
- Automation Guide - GitHub Actions workflows
- API Reference - Programmatic usage
- Examples - Sample configurations
| Type | Languages | Frameworks | Features |
|---|---|---|---|
| Web App | JS/TS, Python, Go | React, Vue, Django, Express | Full-stack setup, deployment |
| CLI Tool | Go, Rust, Python, JS | Cobra, Clap, Click, Commander | Binary building, distribution |
| Library | All supported | Framework-specific | Package publishing, docs |
| API | Python, Go, JS, Java | FastAPI, Gin, Express, Spring | OpenAPI specs, testing |
| Mobile | Dart, Swift, Kotlin | Flutter, React Native | Platform builds, stores |
| Desktop | JS/TS, Go, Rust | Tauri, Electron | Cross-platform building |
| Data Science | Python, R | PyTorch, TensorFlow | Notebook setup, viz tools |
| Documentation | Markdown | MkDocs, Sphinx | Site generation, hosting |
- SECURITY.md with vulnerability reporting guidelines
- Dependabot for automated dependency updates
- CodeQL analysis for security vulnerabilities
- Bandit security scanning for Python
- Branch protection rules
- Required reviews and status checks
Contributions are welcome! Please read our Contributing Guide for details.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Add tests if applicable
- Submit a pull request
This project is released into the public domain under the Unlicense.