aspirepress/AspireCloud
0
0
Fork 0
mirror of https://gh.wpcy.net/https://github.com/aspirepress/AspireCloud.git synced 2026-07-16 11:26:56 +08:00
Code Issues Projects Packages Wiki Activity Actions
AspireCloud is an API server for WordPress, partially implementing the api.wp.org specifications, and proxying the rest
83 commits 17 branches 50 tags 4.3 MiB
Find a file
Exact
Sarah Savage b8397d80e4 Updating point to db repo 
Signed-off-by: Sarah Savage <me@sarah-savage.com>
2024-10-13 06:37:08 -04:00
.github/workflows Running our litany of checks 2024-10-10 15:22:35 -04:00
bin Improving the way we handle network creation/removal 2024-10-06 13:44:22 -04:00
config Adding baseline, fixing some missing test paths 2024-10-10 08:01:25 -04:00
data Initial commit. 2022-11-22 15:19:13 -05:00
db@4fe8ce6051 Updating point to db repo 2024-10-13 06:37:08 -04:00
docker Adding psql to webapp dev container 2024-10-03 07:52:09 -04:00
logs Initial commit. 2022-11-22 15:19:13 -05:00
public Improvements and upgrades 2024-10-10 07:43:50 -04:00
spec Updating Makefile with run command 2024-10-06 13:37:56 -04:00
src Updating naming to follow our conventions 2024-10-10 07:39:46 -04:00
tests Adding baseline, fixing some missing test paths 2024-10-10 08:01:25 -04:00
.env.dist Updating the env file with the correct database 2024-09-28 14:12:51 -04:00
.gitignore Updating skeleton to reflect more modern dependencies/methodologies. 2023-05-06 09:07:35 -04:00
.gitmodules Making the DB a submodule 2024-10-07 12:16:12 -04:00
baseline.neon Updatinb baseline because we've renamed everything 2024-10-10 08:17:22 -04:00
behat.yml Adding baseline, fixing some missing test paths 2024-10-10 08:01:25 -04:00
CHANGELOG.md Adding a changelog 2024-10-07 05:01:12 -04:00
composer.json Improvements and upgrades 2024-10-10 07:43:50 -04:00
composer.lock Improvements and upgrades 2024-10-10 07:43:50 -04:00
docker-compose.override.yml.dist Upgrading node dependencies. 2024-04-26 16:24:05 -05:00
docker-compose.yml Improvements and upgrades 2024-10-10 07:43:50 -04:00
LICENSE Updating license file 2024-10-06 06:28:22 -04:00
Makefile Adding database configuration for test 2024-10-07 10:55:27 -04:00
phpcs.xml.dist Updating Makefile and including a new coding standard. 2024-04-26 16:13:57 -05:00
phpstan.neon Updatinb baseline because we've renamed everything 2024-10-10 08:17:22 -04:00
phpunit.xml.dist Initial commit. 2022-11-22 15:19:13 -05:00
README.md Renaming the project in the README 2024-10-10 07:46:57 -04:00

README.md

AspireCloud

This project is designed to function as a CDN/API endpoint system for distributing WordPress assets (themes, plugins, core) to users of the AspirePress Updater. It is free software, with the condition that it must not be used for commercial gain when distributing freely available products.

Setup

  1. Run make init to initialize the project.
  2. Configure WordPress to use your local version of AspireCloud.
  3. You should now be online!

XDebug Instructions for PHPStorm

  1. Go to Settings > PHP > Debug and check "Break at first line of PHP scripts."
  2. Go to Settings > PHP > Servers and create a server with your desired hostname.
  3. Edit the docker-compose.override.yml.dist file so that the server name matches the one you entered in Step #2.
  4. Copy docker-compose.override.yml.dist to docker-compose.override.yml to include it in Docker. Then run make down up to restart Docker.
  5. Go to Run > Edit Configurations. Add a PHP Remote Debug configuration. Select your server and enter the PHPSTORM IDE key.
  6. Click the debug icon to start listening for debug connections.
  7. Refresh the page. It should stop at the first line of execution. If not, repeat the steps and use xdebug_info() to verify XDebug’s activity.
  8. Once debugging works, remove the "Break at first line..." setting from Step #1 to allow the program to progress until it hits breakpoints.

Notes

AspireCloud operates as an API and a pseudo pull-through cache against WordPress.org. This means that if AspireCloud provides the requested endpoint, it attempts to deliver the resource; otherwise, it passes the request through to WordPress.org and returns their response to the end user.

The long-term goal is to gradually implement WordPress.org APIs to reduce reliance on their website and endpoints.

Important: Please do not use this project to flood or harass the WordPress.org website. We don't want to get banned from using their resources!

License

This project is licensed under the MIT License. You may exercise all rights granted by the MIT license, including using this project for commercial purposes.