Open Apparel Registry
The Open Apparel Registry (OAR) is a tool to identify every apparel facility worldwide.
- Vagrant 2.1+
- VirtualBox 5.0+
- AWS CLI 1.1+
- IAM credentials (for artifacts, secrets, etc)
First, configure a local AWS profile with access to an S3 bucket with files containing project specific environment variables:
$ aws configure --profile open-apparel-registry AWS Access Key ID [None]: AKIAIOSFODNN7EXAMPLE AWS Secret Access Key [None]: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY Default region name [None]: eu-west-1 Default output format [None]:
setup to bring up the development environment:
setup will provision a Vagrant VM, using
vboxsf to mount
./ (relative to
/vagrant, as well as
/home/vagrant/.aws, and execute
setup, you can access the VM by running:
$ vagrant ssh vagrant@vagrant:/vagrant$
To start the application, run:
# Access the VM console $ vagrant ssh # Start the application vagrant@vagrant:/vagrant$ ./scripts/server
The legacy API is included in this repository. It uses Restify, a NodeJS framework, and MongoDB with ElasticSearch.
To start this version of OAR, first, bootstrap the database:
# Access the VM console $ vagrant ssh # Import database dumps from Sourcemap and run ElasticSearch indexing vagrant@vagrant:/vagrant$ export OAR_SETTINGS_BUCKET=openapparelregistry-development-config-eu-west-1 vagrant@vagrant:/vagrant$ ./scripts/bootstrap --restify
# Start the application vagrant@vagrant:/vagrant$ ./scripts/server --restify
There is a separate
docker-compose.restify.yml file that contains the legacy Docker Compose services.
The NodeJS backend uses Nodemon to monitor for any source code changes and will automatically restart.
Because the frontend uses Create React App, which integrates with webpack, the page will automatically reload if you make changes to the code.
To destroy any existing development database and load fresh fixture data including users, facility lists, facility matches, and facilities run:
|React development server||
|Gunicorn for Django app||
|Restify development server||
||Import database dumps from Sourcemap, run
||Plan and apply remote infrastructure changes|
||Clear development database & load fixture data including users, facility lists, matches, and facilities|
||Provision Vagrant VM and run
||Builds and pulls container images using docker-compose|
||Generate a new API key associated with the UID defined by