🌐 WebEdit Server

The code related to the server is stored in apps/server.

Where? What? How?

To understand what components the WebEdit Server is made of and how it integrates with the rest, check out the Structure documentation.

3.. 2.. 1.. LAUNCH!

If you want to know how to start the server for development, then have a look at the “Run for development” Documentation.

Configuration

The server is entirely configured through environment variables that try to load sane defaults.

In the server path there is a .env file with almost all available environment variables. The variable names should hopefully be self-explanatory. There is also a .env.test file with overrides for running the test suite.

If you need to locally change something, please create a .env.local and a .env.test.local respectively, and make your changes in those files. They take precedence when Bun loads environment variables and are not checked into Git.

File Structure

server
├── src → contains the source code
│   ├── garage.ts → code to initialize garage
│   ├── valkey.ts → code to initialize valkey
│   ├── hocuspocus.ts → code for hocuspocus server
│   ├── index.ts → entrypoint for server and setup of REST API
│   ├── api → contains the definition of the REST API routes
│   │   ├── admin → /api/admin api routes
│   │   ├── auth → /api/auth api routes
│   │   │   ├── signin → /api/auth/signin api routes
│   │   └── blob → /api/auth/blobs api routes
│   │   └── media → /api/auth/media api routes
│   ├── utilities → contains generic code for the server
├── staticFiles → for non-code files required by the server

Tests

Tests are defined in files ending with .test.ts and require Valkey and Garage to be running and available on the hostname and port defined in the servers .env or if you want to use different ones for tests in .env.test. To run the tests, navigate into the server folder (/apps/server) and run:

bun test --coverage

The --ceverage flag will also generate a coverage report and print it to the console.

Endpoint Documentation

The server automatically generates a Swagger documentation that can be accessed when the server is running. The URI depends on your current dev setup but is probably either https://localhost:3000/api/docs or https://localhost:3002/api/docs.

It can also be accessed through our demo deployment: https://demo.webedit.site/api/docs

Helpful Links

• ElysiaJS Tutorial
• ElysiaJS Validation Guide
• ElysiaJS Cookie Pattern
• ElysiaJS Unit Test Guide
• ElysiaJS Unit Test Pattern
• ElysiaJS Eden Treaty Guide
• Bun Documentation