epanet-js

⚠️ License notice: This project is under the Functional Source License (FSL-1.1-MIT). You can use and contribute freely for personal, research, and internal purposes. Commercial or competing uses are not allowed until a commit transitions to MIT after two years. If you work for a commercial entity, consult your legal team before downloading, viewing or adapting this code - learn more.

epanet-js is a web application that makes EPANET accessible from the browser.

!epanet-js app

The project is a NextJS application built ontop of Placemark. Although most of the logic occurs on the browser, it uses cloud functions to protect secrets and authenticate users.

Before you use or view this code

This project is licensed under the Functional Source License (FSL-1.1-MIT). That means:

✅ What you _can_ do right now

• Use the code for personal projects, research, or education
• Explore, learn from, and contribute improvements back
• Deploy it internally for your own organization’s use, including making modifications for your own needs
• Share forks and modifications as long as they respect the license

• Package this code into your own commercial app or service
• Build a competing product (commercial or open source) that offers the same functionality
• Sell or offer hosted versions of this project

• You’re welcome to read the code to understand how it works, or to learn from it.
• But adapting it directly for your own commercial product or service is not allowed under the FSL.
• Even downloading or viewing the code could put your company at legal risk — please check with your internal legal team before doing so.

This model helps prevent harmful free riding and keeps development sustainable. If you’re curious, you can read more about why we chose this approach on our website.

Getting started

Install dependencies

Before installing epanet-js, you will need a functional C/C++ toolchain, as well as installing the following libraries:

• libpixman
• libcairo
• libpango
• libgif

sudo apt update
sudo apt install libpixman-1-dev
sudo apt install libcairo-dev
sudo apt install libpango1.0-dev
sudo apt install libgif-dev

Then, run:

pnpm install

##### Issues with Apple Silicon We use the node-canvas library and the version we use does not include a packaged build for Apple Silicon. There is a build script available but pnpm does not launch it automatically. If you run into problems try the following:

1. Manually install the dependencies to run the build script official documentation
2. Manually execute the canvas package build script

cd node_modules/canvas
npm run install

Configuration

Copy the contents from .env.example to .env and edit with the values from your accounts.

Dev server

You can start the dev server with the following command.

pnpm --filter @epanet-js/app dev

Visit http://localhost:3000.

_Notice: if you see a ChunkLoadError, try refreshing the page._

Run tests

pnpm --filter @epanet-js/app test

Or in watch mode:

pnpm --filter @epanet-js/app test:watch

Check types

pnpm --filter @epanet-js/app check-types

Or in watch mode:

pnpm --filter @epanet-js/app check-types:watch

Run linter

pnpm --filter @epanet-js/app lint

Pre-commit hook

To prevent pushing code that has linter or types errors you can add to .git/hooks/pre-commit the following:

#!/bin/sh
echo "Running type check..."
pnpm --filter @epanet-js/app run check-types || exit 1
echo "Running lint..."
pnpm --filter @epanet-js/app run lint || exit 1
echo "✅ All checks passed!"

Deploy

You will need to configure the environment variables for the deployment. You can find the list of variables in .env.example.

To deploy you will need to run the next build.

In Vercel you can use this command:

pnpm --filter @epanet-js/app lint && NODE_ENV=test pnpm --filter @epanet-js/app test && NODE_ENV=production pnpm --filter @epanet-js/app build

License

This repository contains code under two different licenses:

1. Placemark clone (MIT License): All code from the first commit (0fa095f5c60ba944fa4e25b8a7e749e52c2beefb) is licensed under the MIT License.
2. Modifications and Future Contributions (FSL-1.1-MIT): Any changes or contributions made after the first commit (0fa095f5c60ba944fa4e25b8a7e749e52c2beefb) onwards are licensed under the FSL-1.1-MIT License.