https://github.com/fishjam-cloud/documentation
Home of Fishjam documentation
https://github.com/fishjam-cloud/documentation
Last synced: 4 months ago
JSON representation
Home of Fishjam documentation
- Host: GitHub
- URL: https://github.com/fishjam-cloud/documentation
- Owner: fishjam-cloud
- License: apache-2.0
- Created: 2024-09-11T09:58:57.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-12T11:36:22.000Z (8 months ago)
- Last Synced: 2025-11-12T12:05:23.633Z (8 months ago)
- Language: MDX
- Homepage: http://docs.fishjam.io/
- Size: 2.36 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fishjam Documentation
You can access generated documentation here:
### What is inside?
The Documentation explains how Fishjam works and how it can be integrated in your mobile or web application
### Local Development
#### Python
`python-server-sdk` requires [uv](https://docs.astral.sh/uv/). Make sure to have it installed first.
#### yarn
Get all dependencies
```
yarn
```
Fetch packages source code:
```
yarn prepare
```
and run development preview
```
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without
having to restart the server.
#### Build
```
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting
service.
#### Deployment
Documentation is deployed automatically with each PR. See [Deploy Docusaurus](.github/workflows/docs.yaml) action
### Docusaurus
Documentation is built using [Docusaurus](https://docusaurus.io/), a modern static website generator..
## License
Licensed under the [Apache License, Version 2.0](LICENSE)
## Fishjam is created by Software Mansion
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile
apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help
you build your next dream product –
[Hire us](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=docs-readme).
[](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=docs-readme)