# ui-users

Copyright (C) 2017 The Open Library Foundation

This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.

## Introduction

Stripes UI module: administrating users

# ui-users

Copyright (C) 2017 The Open Library Foundation

This software is distributed under the terms of the Apache License,
Version 2.0. See the file "[LICENSE](LICENSE)" for more information.

## Introduction

The Users UI Module, or `ui-users`, is a Stripes UI module used for searching, sorting, filtering, viewing, editing and creating users. (A "Stripes UI module" is an NPM module that adheres to certain convention that allow it to function within [the Stripes UI framework](https://github.com/folio-org/stripes-core/blob/master/README.md) that is part of FOLIO.)

The Users UI module is important because it is the first user-facing module to have undergone development. FOLIO has several server-side modules that run under Okapi (mod-auth, mod-configuration, mod-metadata, mod-files, etc.), but mod-users is the only one that has a corresponding UI component. Accordingly, the Users UI module serves as a testbed for new Stripes functionality and an place to shake down those parts of the UI design that will be shared between all FOLIO applications.

## Installation

First, you will need Stripes running -- see the detailed instructions for running it [from NPM repositories](https://github.com/folio-org/stripes-core/blob/master/doc/quick-start.md) or [from git checkouts](https://github.com/folio-org/stripes-core/blob/master/doc/building-from-git-checkouts.md).

You will then need to build and install Okapi and the server-side Users module as described in [_Running a complete FOLIO system_](https://github.com/folio-org/ui-okapi-console/blob/master/doc/running-a-complete-system.md), and install the Users UI module as described [further down that same document](https://github.com/folio-org/ui-okapi-console/blob/master/doc/running-a-complete-system.md#set-up-the-module-tenant-and-users).

(At some point, this process will be dramatically streamlined; but at present, this software is primarit for developers to work on, rather then for users to use.)


Add more prose. There is surprisingly little to say.
Add more prose. There is surprisingly little to say.
