Merge pull request #69 from NYPL-Simplified/comments

Comments

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Changelog
 
+### v1.4.13
+#### Added
+- Put in comments for clarity.
+- Updated README for clearer startup instructions through Docker.
+
 ### v1.4.12
 #### Fixed
 - Fixed failing MonthlyDataTab tests.

README.md

@@ -1,4 +1,4 @@
-# registry-admin
+# Registry Admin
 Web front-end for the Library Registry administrative interface.
 
 <!-- [![npm version](https://badge.fury.io/js/simplified-circulation-web.svg)](https://badge.fury.io/js/simplified-circulation-web)
@@ -11,36 +11,49 @@ To see screenshots, read in-depth documentation, and find out more about the pro
 
 ## Setup
 
-This package is meant to be used with the Library Simplified [Library Registry](https://github.com/NYPL-Simplified/library_registry).
+This package is meant to be used with the Library Simplified [Library Registry](https://github.com/NYPL-Simplified/library_registry). The Library Registry is the main server app that runs and exposes endpoints that the Circulation Manager will use and also runs this front-end admin interface application.
 
-#### Use npm version
+### Cloning this repository
 
-Suggested local folder setup:
-- `/[path to project folder]/library_registry`
+As written in the Library Registry [README](https://github.com/NYPL-Simplified/library_registry), you **must** install both repos in the _same_ directory.
 
-To use the published version with your circulation manager, run `npm install` from the `library_registry` local installed repository.
+Let's say your working path is `~/projects/simplified/registry`, then change directory into the working path:
 
-#### Use local development version
+```sh
+cd ~/projects/simplified/registry
+```
+
+and run:
+
+```sh
+git clone https://github.com/NYPL-Simplified/library_registry.git
+git clone https://github.com/NYPL-Simplified/registry_admin.git
+```
+
+Having both repos in the same directory allows the Library Registry's Docker configuration to read this app for local development.
+
+### Installation
+
+One the repo is cloned, change directory to `registry_admin` and then install the  dependencies.
+
+```sh
+cd registry_admin
+npm install
+```
 
-Suggested local folder setup:
-- `/[path to project folder]/library_registry`
-- `/[path to project folder]/registry_admin`
+### Use Local Development Version
 
-If you're working on the administrative interface and want to test local changes, you can link your local clone of this repository to your local circulation manager. These steps will allow you to work on the front-end administrative interface and see updates while developing.
+If you're working on the administrative interface and want to test local changes, follow the [Library Registry's README](https://github.com/NYPL-Simplified/library_registry) to run the server through Docker. **You do not need to use `npm link` in this setup.** If both the Library Registry and the Registry Admin are in the same directory, when the server is started through the Docker cluster it'll pick up this repo automatically.
 
-1. Run `npm link` in this `registry_admin` repository,
-2. run `npm link simplified-registry-admin` from the `library_registry` repository,
-2. run the library registry using `python app.py` at the root in the `library_registry` repository,
-3. run the web interface using `npm run dev` at the root of this `registry_admin` repository,
-4. visit `localhost:7000/admin/`
+Visit `localhost/admin/` to see the front-end admin interface.
 
-Webpack will take care of compiling and updating any new changes made locally for development. Just refresh the page to see updates without having to restart either the `library_registry` or `registry_admin` servers.
+Now you can make front-end changes to this repo and the Docker cluster will pick up any changes that are made. The Docker cluster's local dev server will take care of compiling and updating any new changes made locally for development. Just refresh the page to see updates without having to restart either the `library_registry` or `registry_admin` servers.
 
 ## Publishing
 
-<!-- This package is [published to npm](https://www.npmjs.com/package/simplified-circulation-web). -->
+This package is [published to npm](https://www.npmjs.com/package/simplified-circulation-web).
 
-To publish a new version, you need to create an npm account and be a collaborator on the package. Then you can run `npm publish` from your local copy of the repository.
+To publish a new version, you need to create an npm account and be a collaborator on the package. Then you can run `npm publish` at the root of this repository to release a new version. Speak to an engineering at NYPL to be added as a collaborator in the npm NYPL organization.
 
 ## Accessibility