https://github.com/muchokidavid/bc-ferry-web-app
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.
https://github.com/muchokidavid/bc-ferry-web-app
ferry-schedules public-api public-transport
Last synced: 4 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/muchokidavid/bc-ferry-web-app
- Owner: MuchokiDavid
- License: mit
- Created: 2023-11-01T08:54:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-11-07T13:54:37.000Z (over 2 years ago)
- Last Synced: 2025-11-14T17:09:29.402Z (7 months ago)
- Topics: ferry-schedules, public-api, public-transport
- Language: HTML
- Homepage: https://kaleidoscopic-crumble-36e2d5.netlify.app
- Size: 541 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#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:
```bash
git clone https://github.com/dmmuchoki7/bc-ferry-web-app.git
```
2. Navigate to the project directory:
```bash
cd bc-ferry-web-app
```
3. Install the required dependencies:
```bash
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.
```bash
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