BC Ferry Sailing Data Web App - Using Public API

This web app is designed to retrieve current data on BC Ferries sailings using the BC Ferry public API. It provides information on sailings, routes, and other related data. This README will guide you through the project setup and usage.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• API Reference
• Contributing
• License

Getting Started

Prerequisites

Before you begin, ensure you have the following prerequisites:

• Node.js and npm installed.
• An API key from BC Ferries (insert link to API registration).

Installation

1. Clone the repository to your local machine:

   git clone https://github.com/dmmuchoki7/bc-ferry-web-app.git

2. Navigate to the project directory:

   cd bc-ferry-web-app

3. Install the required dependencies:

   npm install

API Reference

The web app uses the BC Ferries public API to retrieve data. Please refer to the BC Ferries API documentation for details on available endpoints, request parameters, and response formats.

https://github.com/samuel-pratt/bc-ferries-api/blob/master/README.md

Contributing

I welcome contributions to this project. If you'd like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix: git checkout -b feature new-feature.
3. Make your changes and commit them: git commit -m 'Add new feature'.
4. Push to the branch: git push origin feature/new-feature.
5. Create a pull request.

License

This project is licensed under the MIT License.

Author

Muchoki David Munuhe