# Featmap
Featmap is a user story mapping tool for product people to build, plan and communicate product backlogs.
![Featmap screenshot](screenshot.png)
- [Introduction](#introduction)
- [Purpose](#purpose)
- [Features](#features)
- [Intended audience](#intended-audience)
- [Motivation](#motivation)
- [Getting started](#getting-started)
- [Self hosting](#self-hosting)
- [Requirements](#requirements)
- [Download](#download)
- [Configuration](#configuration)
- [Run](#run)
- [Upgrade](#upgrade)
- [Building from source and running with docker-compose](#Building-from-source-and-running-with-docker-compose)
- [Monetization](#monetization)
- [License](#license)
## Introduction
Featmap is an open source user story mapping tool. It is built using React, Typescript and Go.
### Purpose
Featmap was built for product people to take advantage of a technique called *user story mapping*. User story mapping, or just story mapping, is an effective tool to create, plan and communicate your product backlog. Story mapping was created by Jeff Patton and its primary utility is providing us with an overview of the entire product and how user goals are broken down into a series of tasks. Finally, it helps us to define valuable product slices (releases) and prioritize between them.
### Features
* Personas
* Markdown editing
* Discuss user stories
* Share your user story maps with external stakeholders
* User story annotations
* User story estimates with roll-ups
### Intended audience
Featmap is great for product managers, product owners or just about anyone who is building products. Featmap can also be used as a light weight work item management system for development teams.
### Motivation
There are many user story mapping tools, however none are really focused on easy-of-use and simplicity. Featmap was built to fill that gap. We hope you will find it as useful as we found building it.
## Getting started
You have two choices when it comes to using Featmap.
1. Use our hosted service at https://www.featmap.com. This is the most simple way of using Featmap. Note that we also offer a free trial.
2. Host it yourself by running it on you own server, without cost. Please refer to the [instructions](#self-hosting) for self-hosting.
## Self hosting
Featmap can be run on your own server.
### Requirements
Featmap runs on top of [PostgreSQL](https://www.postgresql.org/), 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.
### Download
[Download](https://github.com/amborle/featmap/releases) the Featmap binary for your respective platform and save it somewhere on your system. If needed, make it executable on your system.
### Configuration
In the directory where you placed the binary, create a file called ```conf.json```.
Here's a sample ```conf.json``` you can use:
```json
{
"appSiteURL": "https://localhost:5000",
"dbConnectionString": "postgresql://postgres:postgres@postgres:5432/postgres?sslmode=disable",
"jwtSecret": "ChangeMeForProduction",
"port": "5000",
"emailFrom": "",
"smtpServer": "",
"smtpPort": "587",
"smtpUser": "",
"smtpPass": "",
"environment": "development"
}
```
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`, Featmap assumes your are **not** running on **https** and the the backend will not serve secure cookies. Remove this setting if you have set it up to run https.
### Run
Execute the binary.
```bash
./featmap-1.0.0-linux-amd64
Serving on port 5000
```
Open a browser to http://localhost:5000 and you are ready to go!
### Upgrading
Just download the latest release and swap out the executable. Remember to backup your database and the old executable.
## Building from source and running with docker-compose
Clone the repository
```bash
git clone https://github.com/amborle/featmap.git
```
Navigate to the repository.
```bash
cd featmap
```
Let's copy the configuration files
```bash
cp config/.env .
cp config/conf.json .
```
Now let's build it.
```bash
docker-compose build
```
Startup the services, the app should now be available on the port you defined in you configuration files (default 5000).
```bash
docker-compose up -d
```
## Monetization
We believe Featmap is a great tool for product people and we want as many as possible to benefit from it, this is our primary goal. Therefore Featmap is open source and we offer Featmap free of charge for anybody to run on their own server. That being said, it would also be great if Featmap can generate some income. Featmap is offered as a paid service over at https://www.featmap.com. We believe this model is great because it allows us to sustainably build an open source app that as many as possible can benefit from.
## License
Featmap is licensed under Business Source License 1.1. See [license](https://github.com/amborle/featmap/blob/master/LICENSE)
没有合适的资源?快使用搜索试试~ 我知道了~
featmap:简单和开源的用户故事映射工具
共173个文件
tsx:47个
ts:45个
sql:22个
5星 · 超过95%的资源 需积分: 26 4 下载量 51 浏览量
2021-03-29
01:14:17
上传
评论
收藏 528KB ZIP 举报
温馨提示
专题图 Featmap是用于产品人员构建,计划和传达产品积压工作的用户故事映射工具。 介绍 Featmap是一个开源的用户故事映射工具。 它是使用React,Typescript和Go构建的。 目的 Featmap专为产品人员构建,以利用一种称为用户故事映射的技术。 用户故事映射,或者仅仅是故事映射,是创建,计划和传达您的产品待办事项列表的有效工具。 故事映射是由Jeff Patton创建的,它的主要实用程序为我们提供了整个产品的概述以及如何将用户目标分解为一系列任务。 最后,它有助于我们定义有价值的产品分类(版本)并在它们之间确定优先级。 特征 角色 降价编辑 讨论用户故事 与外部利益相关者共享您的用户故事图 用户故事注释 汇总的用户故事估算 目标受众 Featmap非常适合产品经理,产品所有者或几乎所有正在构建产品的人。 Featmap还可以用作开发团队的轻量级工作项目管理系统。 动机
资源详情
资源评论
资源推荐
收起资源包目录
featmap:简单和开源的用户故事映射工具 (173个子文件)
App.css 15KB
index.css 380B
.env.development 111B
Dockerfile 556B
.env 97B
.gitignore 1017B
.gitignore 313B
service.go 52KB
workspace-api.go 30KB
repo.go 27KB
model.go 10KB
stripe.go 7KB
mware.go 7KB
users-api.go 5KB
main.go 5KB
account-api.go 3KB
shared.go 2KB
email.go 2KB
response.go 2KB
subscription-api.go 2KB
link-api.go 1KB
lexorank.go 954B
lexorank_test.go 161B
index.html 2KB
favicon.ico 15KB
package-lock.json 708KB
package.json 1KB
tsconfig.json 535B
conf.json 327B
manifest.json 306B
LICENSE 4KB
readme.md 5KB
go.mod 624B
screenshot.png 105KB
screenshot.png 74KB
android-chrome-512x512.png 10KB
android-chrome-192x192.png 3KB
apple-touch-icon.png 2KB
favicon-32x32.png 360B
favicon-16x16.png 236B
build_all_arch.sh 367B
generate.sh 257B
complete_build.sh 209B
build_webapp.sh 116B
8_features.up.sql 2KB
5_milestones.up.sql 1KB
7_subworkflows.up.sql 1KB
6_workflows.up.sql 1KB
17_feature_comments.up.sql 1KB
18_feature_comment_owners.up.sql 1KB
4_projects.up.sql 994B
10_invites.up.sql 987B
9_subscriptions.up.sql 982B
22_workflow_personas.up.sql 981B
2_accounts.up.sql 942B
3_members.up.sql 650B
21_personas.up.sql 621B
1_workspaces.up.sql 412B
19_annotations.up.sql 371B
15_subscriptions.up.sql 300B
13_delete_member.up.sql 231B
16_workspaces.up.sql 205B
14_add_last_login.up.sql 89B
11_subworkflows_add_status.up.sql 75B
12_workflows_add_status.up.sql 72B
20_estimates.up.sql 64B
go.sum 63KB
avatar07.svg 5KB
avatar02.svg 5KB
avatar04.svg 4KB
avatar05.svg 4KB
avatar06.svg 4KB
avatar00.svg 4KB
avatar03.svg 4KB
avatar08.svg 4KB
avatar01.svg 4KB
invite.tmpl 410B
reset.tmpl 254B
welcome.tmpl 223B
email.tmpl 129B
index.ts 32KB
misc.ts 23KB
serviceWorker.ts 5KB
reducers.ts 3KB
reducers.ts 2KB
reducers.ts 2KB
reducers.ts 2KB
actions.ts 2KB
index.ts 2KB
actions.ts 2KB
actions.ts 2KB
actions.ts 2KB
types.ts 1KB
reducers.ts 1KB
actions.ts 1KB
lexorank.ts 1KB
actions.ts 1KB
reducers.ts 1KB
actions.ts 1KB
reducers.ts 1KB
共 173 条
- 1
- 2
李念遠
- 粉丝: 18
- 资源: 4616
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论1