@surfskip/api-types

surfskip-api

An API written using Bun and Elysia for our web application.

This repository hosts the server code, but as you can see, we export typings for our NPM package to use them with @elysiajs/eden to deliver a full type safe client.

Usage of the NPM package with @elysiajs/eden

Install the packages using...

# With pnpm...
pnpm add @surfskip/api-types @elysiajs/eden

and import them wherever in your code...

import type { SurfSkipApi } from "@surfskip/api-types";
import { edenTreaty } from "@elysiajs/eden";

export const api = edenTreaty<SurfSkipApi>("https://api.surfskip.com");

You're setup! You can now use this api object to call whatever function from our API. If needed, you can read more about how @elysiajs/eden works.

Contributing to repository

We use Bun for that API. That means that we have to use WSL for development on Windows, else a Linux or macOS machine works fine.

Windows support is currently in development.

Bun can be installed with the following command:

curl -fsSL https://bun.sh/install | bash

If you have Bun installed, you can now install the dependencies with the following command:

bun install

Add environment variables

Make a copy of .env.example to .env. This file will contain the secrets variables, and should not be pushed to GitHub.

cp .env.example .env

You'll see that AWS_REGION variable is already filled. This is because we currently stick to eu-north-1 region. We'll maybe extend it later ?

AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY should have to be filled to have access to DynamoDB.

Scripts

Here's an overview of the scripts defined in package.json.

Command	Description
bun start	Starts the development servers without hot reloading.
bun run dev	Starts the development servers with hot reloading.
bun release	Starts the development servers with hot reloading.
bun run build:types	Creates the typings for the actual server code and put them into the /dist folder. These are the typings we'll publish to NPM.
bun run build:binary	Creates a binary for the actual server code. The binary built is then used in our production servers.