Furway 2.0

Key Features

• Big Things
• Loud Yips
• Fast
• Simple to extend
• Less work for kobolds to maintain

How to Contribute

Contributions are welcome! However, please open an issue first to discuss what you would like to change. There is nothing worse than spending time on a PR that won't get accepted. Once the issue have been approved; fork the project, create a branch, and submit a PR once it is ready to be reviewed.

Besides that, please do your best to follow the Conventional Commits specification. This will help us keep a consistent and readable commit history.

The standard format is: <type>(<scope>): <description>

Scope is completely optional and not commonly used here.

Examples

• feat(payload): add support for user authentication
• fix(block): resolve layout shift issue in header
• chore: update dependencies
• chore: updated documentation and the env example so you can quickly use it
• docs: update readme with installation instructions

Commit Types

• feat – New features
• fix – Bug fixes
• docs – Documentation updates
• style – Code style changes (no logic changes)
• refactor – Code refactoring (no feature changes)
• perf – Performance improvements
• test – Adding or updating tests
• chore – Maintenance tasks (e.g., build process, dependencies, misc changes that don't fall under the other categories)
• ci – CI/CD configuration changes

It is not the end of the world if you forget to follow the convention in one or two commits for your PR, but it is highly recommended to follow it. I usually squash merges anyway, would remove or manually fix the commits if I missed it.

Development

How to Run Locally

Prerequisites:

• pnpm
• Docker
• Docker Compose

Run a local Postgres instance:

cd docker
docker-compose up

Create a .env file for local development:

cp .env.example .env

Run the application:

pnpm install
pnpm dev

Open the application:

http://localhost:3000

Build Dockerfile locally

This will automatically load the .env file and build the image container named furway-dev.

export $(grep -v '^#' .env | xargs) && \
docker build $(grep -v '^#' .env | xargs -I {} echo "--build-arg {}") -t furway-dev .

Run in Docker

Make sure you have the .env file created and populated with the correct values.

docker run --env-file .env -p 3000:3000 furway-dev