Skip to content
DistrictBuilder is web-based, open source software for collaborative redistricting.
TypeScript HCL Shell JavaScript Dockerfile HTML CSS
Branch: develop
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
deployment
doc/arch
public
scripts
src
.gitignore
.prettierrc
Jenkinsfile
LICENSE
README.md
docker-compose.ci.yml
docker-compose.override.yml
docker-compose.yml
package.json
tsconfig.json
tslint.json
yarn.lock

README.md

DistrictBuilder

This project is a continuation of the original version of DistrictBuilder, now called DistrictBuilder Classic, which is no longer being maintained. This repository is where active development of DistrictBuilder will continue to occur.

Note: This repository is in the early stages, and is not yet ready for public use. Please don't attempt to set it up yet, since there are several things that need to be ironed out before it can be used by a wider audience. Please contact districtbuilder@azavea.com to sign up for early access and to learn more.

Overview

DistrictBuilder is web-based, open source software for collaborative redistricting.

Requirements

Development

Ensure that you have an AWS credential profile for district-builder configured on your host system. The server backend will need this in order to access S3 assets.

Run scripts/setup to prepare the development environment:

$ ./scripts/setup

Next, run scripts/server to start the application:

 $ ./scripts/server

Note: It is recommended to configure your editor to auto-format your code via Prettier on save.

Hot Reloading 🔥

While server is running, the Create React App frontend will automatically reload when changes are made. Additionally, the NestJS backend will restart when changes are made.

Project Organization

In order to allow for code-sharing across the frontend and backend in conjunction with an unejected Create React App (CRA), it was decided that the simplest and least error-prone way forward was to structure the code as such:

.
├── package.json (Applies to the CRA frontend)
├── src
│   ├── client (Location for all CRA frontend code)
│   ├── index.tsx (This and another file need to be here for CRA-purposes)
│   ├── manage (Command-line interface)
│   │   ├── package.json (Applies to the command-line interface)
│   ├── server (NestJS backend code)
│   │   ├── package.json (Applies to the NestJS backend)
│   └── shared (Code that is used by both the frontend and backend)

Stack

Ports

Port Service
3003 Create React App
3005 NestJS

Scripts

Name Description
cibuild Build application for staging or a release.
cipublish Publish container images to Elastic Container Registry.
dbshell Enter a database shell.
infra Execute Terraform subcommands with remote state management.
manage Execute commands with the manage CLI tool.
migration Execute TypeORM migration CLI commands.
server Bring up all of the services required for the project to function.
setup Setup the project's development environment.
test Run linters and tests.
update Build container images, update dependencies, and run database migrations.
yarn Execute Yarn CLI commands.

Command Line Interface

A command line interface is available for performing data processing operations. See src/manage/README.md for more info.

You can’t perform that action at this time.