⚠️ Notice:
This code has moved into holonym-foundation/id-server.
Development continues there. This repo is no longer maintained.

Setup

First, install Bun. You can install it by running:

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

Or follow the official installation guide.

Clone the repo.

git clone https://github.com/holonym-foundation/phone-number-server.git

Install dependencies with bun.

bun install

Set environment variables. You might need to contact the team to get the values of some of these variables.

cp .env.example .env

Run redis on localhost:6379. You can do this with redis-server OR docker. The docker command might be different depending on your OS.

# redis-server
redis-server

# docker
docker run -p 6379:6379 redis

Run the development server.

bun run start

Or simply:

bun check-number.ts

Docker

This server can also be run using Docker with Bun.

Building the Docker image

docker build -t phone-number-server .

Running the Docker container

docker run --network host --restart always --env-file .env phone-number-server

TypeScript

This project is written in TypeScript. You can run type checking with:

bun run type-check

Contributing

Git practices

We use a style of Gitflow.

• All changes should be pushed to the dev branch.
• If a feature takes a while (e.g., weeks) to implement, prefer creating a feature branch. Once the feature is finished, rebase onto dev.
• The main branch is protected. PRs to main can only be merged by authorized individuals. PRs to main are only merged from dev.

Linting and formatting

All commits must pass linting and formatting checks.

Run these commands prior to each commit:

# bun run lint-fix
bun run format-fix