Now What?

REG project tracking tool

Reimagination of whatnow, also borrowing from whatnext.

Prerequisites

• .NET Core 6.0 Runtime and SDK
  • For Mac OSX you can run brew install dotnet (Runtime) and brew install dotnet-sdk (SDK)
  • To test your install is working runt dotnet fsi from the terminal (to quit run #quit;;)

Run dotnet tool restore and then dotnet paket restore.

Setup

Git config

Run script/dev-setup.sh from project root.

App configuration

The app needs the following information to authenticate to the GitHub and Forecast APIs.

• A Github personal access token
  • The scope you need is repo (Full control of private repositories)
• The Forecast ID for your organisation.
  • Most easily found by logging into Forecast via web interface and reading number that appears in URL just after server name
• A Forecast personal access token.
  • Log into Forecast, go to My Profile and then Developers section; there will be an option to obtain a Personal Access Token

Set via config file

• Create a file in ~/.config/nowwhat/secrets.json and add each variable as a top-level JSON field. e.g.

{
  "gitHubToken": "<NOWWHAT_GITHUB_TOKEN>",
  "forecastId": "<FORECAST_ID>",
  "forecastToken": "<NOWWHAT_FORECAST_TOKEN>"
}

Set via environment variables

How to store sensitive environment variables on MacOS may be useful.

• NOWWHAT_GITHUB_TOKEN - GitHub personal access token
• FORECAST_ID - Forecast organisation ID
• NOWWHAT_FORECAST_TOKEN - Forecast personal access token

Building and running

To build or run, in the NowWhat folder run:

dotnet build
dotnet run

Testing

See testing guidelines.

Writing documentation

See

• FSharp.Formatting for the documentation system
• XML documentation for writing docs