https://github.com/flathub-infra/website
Monorepo with website and API
https://github.com/flathub-infra/website
flathub flatpak hacktoberfest python react website
Last synced: 2 months ago
JSON representation
Monorepo with website and API
- Host: GitHub
- URL: https://github.com/flathub-infra/website
- Owner: flathub-infra
- License: apache-2.0
- Created: 2022-03-25T09:00:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:26:27.000Z (7 months ago)
- Last Synced: 2024-10-29T09:47:49.659Z (7 months ago)
- Topics: flathub, flatpak, hacktoberfest, python, react, website
- Language: TypeScript
- Homepage: https://flathub.org
- Size: 31.9 MB
- Stars: 224
- Watchers: 13
- Forks: 88
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/flathub-infra/website/actions/workflows/backend_ci.yml)
[](https://github.com/flathub-infra/website/actions/workflows/frontend_ci.yml)
[](https://hosted.weblate.org/engage/flathub/)
# flathub.org
This is the source code for the website, both backend and frontend. That's running on https://flathub.org.
## Code contribution
First of all thanks for considering contributing to this project!
Pull requests are welcome. Please, create an issue first explaining what you want to do and how.
If you want to contribute translations, please check out the instructions below.
### Overview
This overview is supposed to give you a quick grasp, of what we have and how it works. There are subtle differences between local/prod - this is an approximation.
```mermaid
block-beta
columns 3
block:external:1
columns 1
dl.flathub.org:1
hub.flathub.org/stats:1
end
block:group2
columns 3
fastly:3
down4<[" "]>(down):3
nginx:3
down1<[" "]>(down):3
frontend:3
down2<[" "]>(down):3
hub.flathub.org/stats-->backend
dl.flathub.org-->backend worker backend_node
down3<[" "]>(down):3
db1[("postgres")] db2[("redis")] db3[("meilisearch")]
end
block:external2:1
columns 1
smtp:1
backend_node-->smtp
end
```
### Development
You'll need `git`, `yarn`, `docker` and `docker-compose-plugin`.
Go to the folder where you manage your projects and checkout this project.
Then start the backend:
```sh
cd backend
docker compose up
```
You might need to use `--build` to rebuild the images, when dependencies change.
Use another terminal session to run the following or use your browser to go to https://localhost:8000/docs and use the UI to run the `/update` endpoint.
This will populate the database with the latest data from Flathub.
```sh
curl -X POST localhost:8000/update
```
Then open a terminal and go to the frontend folder.
If it's the first time you run it, run
```sh
yarn
```
Then you should be able to start the dev server and see changes to the code:
```sh
yarn dev
```
### Generating api client
We're generating the api client from the openapi spec. To do so, make sure the backend is running and then run:
```sh
yarn openapi-codegen
```
### Storybook
You can also start the storybook via:
```sh
yarn storybook
```
Or [view the current state of our storybook](https://main--6676acc57f6288e909a4e184.chromatic.com/)
## More backend instructions
You can find more backend instructions in the README in the backend folder.
## Translations
We're using [Weblate](https://hosted.weblate.org/engage/flathub/) to translate the UI. So feel free, to contribute translations over there.
## Stripe payment testing
In both staging and development environments, Stripe is running in test mode (all data is fake).
To test payment, card details can be used from https://stripe.com/docs/testing.
## Thanks
Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.