Skip to content

kbremner/read-more-api

Repository files navigation

read-more-api CircleCI

Backend for ReadMore extension.

Architecture Decisions

This project uses Architecture Decision Records (ADRs) to record decisions made throughout the life of this project. The command line tool adr-tools used for managing these ADRs.

The ADRs for this project can be found here.

Building

The project can be built and run with Visual Studio 2017, or by using the dotnet command line tool.

The solution uses Docker, meaning that the only Windows version that can be used for building this project is Windows 10 Pro.

Running With Chrome Extension

A URL can be specified when building the associated Readmore extension so that it can use a version of this project running locally. Instructions on how to do this can be found here.

Contributing

PRs and issues are welcome, be it to do with code or documentation.

An ADR should be included in a PR when a significant decision around the implementation of this project is made. If the decision outlined by an ADR is to be changed, the PR should include the superseeding of the relevant existing ADR with a new ADR (adr-tools simplifies this process).

About

API backend for Readmore extension

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published