README

Volunteer Manager

Creates a api that may be used to manage volunteer assignments
Report Bug · Request Feature

Table of Contents

• Table of Contents
• [About Volunteer Manager](#about-Volunteer Manager)
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Deploy
• Roadmap
• Contributing
• License
• Acknowledgements

About Volunteer Manager

Here's a blank template to get started:

Built With

• PHP
• NPM
• Webpack
• Modularity

Getting Started

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

Prerequisites

This is an example of how to list things you need to use the software and how to install them (mac os).

• composer

brew install composer

• npm

brew install node

Installation

1. Clone the repo

git clone https://github.com/helsingborg-stad/api-volunteer-manager.git

1. Install and build NPM packages

npm install && npm run build

1. Install composer packages

composer install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Deploy

Instructions for deploys.

Development environment

Devcontainer can be used for development.

1. To start the development environment, open the project in Visual Studio Code and then select "Reopen in Container" from the quick actions menu.
2. When the container is started, run the following commands to install the necessary dependencies: php build.php.
3. Then run composer install.
4. You should then be able to access the project in your browser. You will find the exposed port in the ports section Visual Studio Code.
5. When accessing the project in the browser, you will need to go through the WordPress installation process.
6. Install required plugin Advanced Custom Fields PRO.
7. Activate the plugin Volunteer Manager.

Constants

Google Maps API

Google Maps API key with Maps JavaScript API enabled.

define('GOOGLE_API_KEY', 'xyz');

Roadmap

See the open issues for a list of proposed features (and known issues).

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