README

Schools Manager

A WordPress plugin that creates a api that may be used to manage schools.

Report Bug · Request Feature

About Schools Manager

Built With

• PHP
• WordPress

Getting Started

To get a local copy up and running follow these simple steps.

Development environment (VS Code Devcontainer)

Prerequisites

• Docker
• VS Code

Installation of development environment.

1. Install VS Code.
2. Install the extension Remote Development.
3. Clone this repo.
4. Open the folder in VS Code.
5. Open the command palette (cmd + shift + p).
6. Type Remote-Containers: Reopen in Container and select this alternative.
7. Wait for the container to build.
8. Run composer install in the VS Code integrated terminal.
9. Run the provided VS Code Task install acf pro. This will download and install ACF Pro, which is required for this WordPress plugin to work.

Tests

Run tests

Run composer test in the terminal.

Constants

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License.

Acknowledgements

• othneildrew Best README Template