{"id":23270577,"url":"https://github.com/andrearufo/wordpress-starter","last_synced_at":"2025-04-06T09:42:31.128Z","repository":{"id":268296453,"uuid":"903899777","full_name":"andrearufo/wordpress-starter","owner":"andrearufo","description":"A starter app for a Docker Wordpress container","archived":false,"fork":false,"pushed_at":"2025-01-10T11:44:51.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T15:19:29.474Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrearufo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-15T20:54:55.000Z","updated_at":"2025-01-10T11:44:05.000Z","dependencies_parsed_at":"2024-12-15T21:31:23.923Z","dependency_job_id":"f97c42db-573c-4a25-833c-3d598f32bb15","html_url":"https://github.com/andrearufo/wordpress-starter","commit_stats":null,"previous_names":["andrearufo/wordpress-starter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrearufo%2Fwordpress-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrearufo%2Fwordpress-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrearufo%2Fwordpress-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrearufo%2Fwordpress-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrearufo","download_url":"https://codeload.github.com/andrearufo/wordpress-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247463811,"owners_count":20942940,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-19T18:52:39.501Z","updated_at":"2025-04-06T09:42:31.103Z","avatar_url":"https://github.com/andrearufo.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WordPress Starter Project\n\nThis project provides a complete setup for WordPress development using Docker, WP-CLI, and custom scripts to automate workflows.\n\n---\n\n## Features\n\n- **Docker-based environment**: Includes WordPress, MariaDB, and Mailpit.\n- **Theme setup**: Automatically downloads and configures a theme from a provided URL.\n- **Plugin management**: Installs and activates plugins defined in the `.env` file.\n- **SMTP configuration**: Pre-configures WP Mail SMTP for email testing in development.\n- **Reset functionality**: Resets the environment while preserving specific files.\n\n---\n\n## Prerequisites\n\nEnsure the following tools are installed on your system:\n\n- [Docker](https://www.docker.com/)\n- [Composer](https://getcomposer.org/)\n- [Yarn](https://yarnpkg.com/)\n- `wget`\n- `unzip`\n\n---\n\n## Setup\n\n### 1. Clone the repository\n\n```bash\ngit clone \u003crepository-url\u003e\ncd \u003crepository-folder\u003e\n```\n\n### 2. Configure the `.env` file\n\nCopy the example `.env` file and customize it to your needs:\n\n```bash\ncp .env.example .env\n```\n\nA typical `.env` file:\n\n```env\nTHEME_NAME=starter\nTHEME_PACKAGE_URL=https://github.com/wp-bathe/bathe/archive/master.zip\n\nDOCKER_WORDPRESS_PORT=8888\nDOCKER_DB_PORT=3306\nDOCKER_MAILPIT_PORT=1025\nDOCKER_MAILPIT_DASHBOARD_PORT=8025\n\nDB_MYSQL_ROOT_PASSWORD=rootpassword\nDB_MYSQL_DATABASE=wordpress\nDB_MYSQL_USER=wordpress\nDB_MYSQL_PASSWORD=wordpress\n\nWP_ADMIN_USER=axiostudio\nWP_ADMIN_PASSWORD=powerfull\nWP_ADMIN_EMAIL=noreply@axio.studio\nWP_SITE_TITLE=WordPress Starter\n\nSMTP_HOST=mailpit\nSMTP_PORT=1025\nSMTP_FROM_EMAIL=noreply@localhost\nSMTP_FROM_NAME=WordPress\n\nPLUGINS=bottom-admin-toolbar,disable-comments,force-regenerate-thumbnails,intuitive-custom-post-order,limit-login-attempts-reloaded,redirection,show-current-template,wp-mail-smtp\n```\n\n---\n\n## Usage\n\n### Initialize the Project\n\nRun the following command to initialize the project:\n\n```bash\nbash init.sh\n```\n\nThis script will:\n1. Download and extract the theme.\n2. Build and start Docker containers.\n3. Install WordPress.\n4. Install and configure plugins.\n5. Configure SMTP settings.\n\n### Reset the Environment\n\nTo reset the environment, run:\n\n```bash\nbash init.sh --reset\n```\n\nThis will:\n1. Stop and remove all Docker containers and volumes.\n2. Clean up the project directory, preserving specific files.\n3. Ask if you want to continue with the setup.\n\n### Start the Development Server\n\nRun the following command to start the development server:\n\n```bash\ndocker compose up -d\n```\n\n---\n\n## Files and Directories\n\n- **`init.sh`**: Automates the initialization process.\n- **`reset.sh`**: Resets the environment while preserving essential files.\n- **`docker-compose.yml`**: Defines the Docker services.\n- **`_volumes/`**: Contains persistent data for the database, plugins, and uploads.\n- **`.env`**: Configuration file for environment variables.\n\n---\n\n## Troubleshooting\n\n1. **Docker is not running:**\n   Ensure Docker is installed and running on your system.\n\n   ```bash\n   sudo service docker start\n   ```\n\n2. **Permission errors:**\n   Ensure the scripts have execute permissions:\n\n   ```bash\n   chmod +x init.sh reset.sh\n   ```\n\n3. **SMTP not working:**\n   Check the SMTP settings in `.env` and verify that Mailpit is running.\n\n---\n\n## Customization\n\n- Update the `PLUGINS` variable in `.env` to define the plugins to be installed.\n- Modify `THEME_PACKAGE_URL` to use a different theme zip file.\n- Adjust SMTP settings for custom email providers.\n\n---\n\n## Contributing\n\nFeel free to open issues or submit pull requests for improvements or bug fixes.\n\n---\n\n## License\n\nThis project is licensed under the MIT License.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrearufo%2Fwordpress-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrearufo%2Fwordpress-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrearufo%2Fwordpress-starter/lists"}