VSinerva/freesewing
1
0
Fork 0
Code Activity

chore: Port FreeSewing.dev to docusaurus

Browse source 
The replaces the NextJS site powering FreeSewing.dev with a Docusaurus
setup. It's part of my efforts to simplify FreeSewing's setup so we can
focus on our core value proposition.
This commit is contained in:
Joost De Cock 2024-09-28 13:13:48 +02:00
parent 497633d1d3
commit ab3204f9f1
692 changed files with 11037 additions and 20674 deletions
Download patch file Download diff file Expand all files Collapse all files

61
sites/dev/docs/reference/backend/readme.mdx Normal file
View file

@ -0,0 +1,61 @@
---
title: Backend REST API
---
This is the reference documentation for the FreeSewing backend REST API.
## REST API docs
:::tip
The documentation generated from the OpenAPI specification is available
alt [backend3.freesewing.org/docs/](https://backend3.freesewing.org/docs/)
:::
:::note FIXME
This documentation is under construction.
Meanwhile, check the Swagger docs, linked above.
:::
## About the FreeSewing backend
The FreeSewing backend handles all user data. Prior to version 3 of FreeSewing,
the backend was only used internally as the data store for our frontend, the
FreeSewing.org website.
In version 3, we have rewritten the backend with the explicit goal to offer it
as a service to users and developers. This allows integration with other tools
such as hosted instances of our lab, CLI tools, serverless runners, CI/CD
environments and so on.
In other words, we no longer merely provide our own frontend, you can now also
use our backend as a service to build your own projects.
:::warning
##### Use, don't abuse
Our backend API runs in a cloud environment and while we do not charge for
access to the API, we do need to pay the bills of said cloud provider.
As such, please be mindful of the amount of requests you generate. And if you
have big plans, please reach out to us to discuss them first.
We will monitor the use of our backend API and we may at any moment decide to
revoke API keys if we feel the use is beyond what we can or want to support.
:::
## Database schema
The database schema for the backend is available in the [prisma.schema][prisma]
file in our monorepo.
## Under the hood
The FreeSewing backend is written in [NodeJS](https://nodejs.org/en/) on top of
[Express](https://expressjs.com/). It uses [Prisma](https://www.prisma.io/) to
interface with a [SQLite database](https://www.sqlite.org/) database,
[Sanity](https://www.sanity.io/) to store images, [AWS SES](
https://aws.amazon.com/ses/) to send out emails, and
[pino](https://github.com/pinojs/pino) for logging.