shorif2000/tickr-carbon-offset

Tickr Carbon Offsetting

About The Project

Endpoint exposed at GET /carbon-offset-schedule. Endpoint returns a JSON response with an array of recurring dates

• the dates are sorted by ascending order
• the dates are in ISO 8601 format YYYY-MM-DD
• if a given month doesn't have enough days, uses the last day of the month.
• return a 400 if the request has invalid parameters

Built With

• Laravel

Getting Started

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

Prerequisites

• php 7.4
• composer

Installation

1. Clone the repo

   git clone https://github.com/shorif2000/tickr-carbon-offset.git

2. Install packages

   cd tickr-carbon-offset
   composer update

3. Run server locally

    php artisan serve &

Usage

• Get next 5 months membership schedule dates

  curl -X GET "http://127.0.0.1:8000/api/carbon-offset-schedule?subscriptionStartDate=2021-01-07&scheduleInMonths=5"

• To run tests

  php artisan test --testsuite=Feature

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. See LICENSE for more information.

Contact

Sharif Uddin

Project Link: https://github.com/shorif2000/tickr-carbon-offset