@frontity/source
Version:
Types for the Frontity source namespace
82 lines (48 loc) • 4.34 kB
Markdown
# `@frontity/source`
[](https://www.npmjs.com/package/@frontity/source) [](https://www.npmjs.com/package/@frontity/source) [](https://github.com/frontity/frontity/blob/master/LICENSE)
This package defines the common [interface](https://www.typescriptlang.org/docs/handbook/interfaces.html) (types) to build **source** packages for Frontity
Some packages that [implement this interface](https://www.npmjs.com/browse/depended/@frontity/source) are:
- [`@frontity/wp-source`](https://www.npmjs.com/package/@frontity/wp-source)
## Table of contents
<!-- toc -->
- [Install](#install)
- [Usage](#usage)
- [Feature Discussions](#feature-discussions)
- [Changelog](#changelog)
- [Open Source Community](#open-source-community)
- [Channels](#channels)
- [Get involved](#get-involved)
<!-- tocstop -->
## Install
```sh
npm i @frontity/source
```
## Usage
Any router Frontity package should extend from this package to assure the same _interface_ (API contract)
```ts
import Source, ... from "@frontity/source/types";
interface WpSource extends Source {
...
}
export default WpSource;
```
## Feature Discussions
[**Feature Discussions**](https://community.frontity.org/c/feature-discussions/33) about Frontity are public. You can join the discussions, vote for those you're interested in or create new ones.
These are the ones related to this package: https://community.frontity.org/tags/c/feature-discussions/33/source
## Changelog
Have a look at the latest updates of this package in the [CHANGELOG](CHANGELOG.md)
---
## Open Source Community
### Channels
[](https://community.frontity.org/) [](https://twitter.com/frontity) 
Frontity has a number of different channels at your disposal where you can find out more information about the project, join in discussions about it, and also get involved:
- **📖 [Docs](https://docs.frontity.org/):** Frontity's primary documentation resource - this is the place to learn how to build amazing sites with Frontity.
* **👨👩👧👦 [Community forum](https://community.frontity.org/):** join Frontity's forum and ask questions, share your knowledge, give feedback and meet other cool Frontity people. We'd love to know about what you're building with Frontity, so please do swing by the [forum](https://community.frontity.org/) and tell us about your projects.
* **🐞 Contribute:** Frontity uses [GitHub](https://github.com/frontity/frontity) for bugs and pull requests. Check out the [Contributing](../../CONTRIBUTING.md/) section to find out how you can help develop Frontity, or improve this documentation.
* **🗣 Social media**: interact with other Frontity users. Reach out to the Frontity team on [Twitter](https://twitter.com/frontity). Mention us in your tweets about Frontity and what you're building by using **`@frontity`**.
* 💌 **Newsletter:** do you want to receive the latest news about Frontity and find out as soon as there's an update to the framework? Subscribe to our [newsletter](https://frontity.org/newsletter).
### Get involved
[](https://github.com/frontity/frontity/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
Got questions or feedback about Frontity? We'd love to hear from you in our [community forum](https://community.frontity.org).
Frontity also welcomes contributions. There are many ways to support the project! If you don't know where to start then this guide might help: [How to contribute?](https://docs.frontity.org/contributing/how-to-contribute).
If you would like to start contributing to the code please open a pull request to address one of our [_good first issues_](https://github.com/frontity/frontity/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).