Skip to content
The simple user story mapping tool
TypeScript Go TSQL Other
Branch: master
Clone or download
Pull request Compare This branch is 1 commit ahead, 28 commits behind amborle:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
build
lexorank
migrations
tmpl
webapp
.gitignore
LICENSE
README.md
account-api.go
email.go
go.mod
go.sum
link-api.go
main.go
model.go
mware.go
repo.go
response.go
screenshot.png
service.go
shared.go
users-api.go
workspace-api.go

README.md

Featmap, the simple user story mapping tool

Featmap is a simple user story mapping tool for product managers to build, plan and communicate product backlogs. It is built using React, Typescript and Go. Try it out at www.featmap.com.

Featmap screenshot

How to run locally

Database requirements

Featmap runs on top of PostgreSQL, so make sure you have it running on your system. At this step, make sure to setup the credentials and database that Featmap will use.

Downloading

Download the Featmap binary for your respective platform and save it somewhere on your system.

Configuration

In the directory where you placed the binary, create a file called conf.json.

Here's a sample conf.json

{  
  "appSiteURL": "http://localhost/",
  "dbConnectionString": "postgresql://featmap:featmap@localhost:5432/featmap?sslmode=disable",
  "jwtSecret": "mC3qd44x5hr5YaRhaj5pM5L",
  "port": "80",
  "emailFrom" : "contact@example.com",
  "smtpServer" : "smtp.example.com",
  "smtpPort": "587",
  "smtpUser" : "postmaster@mail.example.com",
  "smtpPass": "some_smtp_password",
  "environment": "production",
  
}
Setting Description
appSiteURL The url to where you will be hosting the app.
dbConnectionString The connection string to the PostgreSQL database that Featmap should connect to.
jwtSecret This setting is used to secure the cookies produced by Featmap. Generate a random string and keep it safe!
port The port that Featmap should run on.
emailFrom The email adress that should be used as sender when sending invitation and password reset mails.
smtpServer SMTP server for sending emails.
smtpPort Optional Will default to port 587 if not specified.
smtpUser SMTP server username.
smtpPass SMTP server password.
environment Optional If set to development, the backend will not serve secure cookies.

It is possible to run Featmap without filling in the mail details, but recovery emails and workspace invites will not be available.

Running

Execute the binary.

./featmap-1.0.0-linux-amd64
Serving on port 80

Open a browser to http://localhost and you are ready to go!

Building

Requirements

The following must be installed on your system in order to build

Instructions

Start by cloning the repository.

git clone https://github.com/amborle/featmap.git

Navigate to the repository.

cd featmap

Now let's build it (requires Bash).

./build/complete_build.sh

Binaries for Linux, Win and Mac are now available in the bin folder.

cd bin
ls
featmap-1.0.3-darwin-amd64  featmap-1.0.3-linux-amd64  featmap-1.0.3-windows-amd64.exe
You can’t perform that action at this time.