The other code repositories include the Movement - Webapp and the Movement - Solr.
Prior to coming to this repo, did you happen to catch our Movement overview?
In the spirit of open-source tooling, we have provided a Scrum board that allows users to keep track of Movement’s issues and enhancements. Anyone can submit a new issue for the tool for something they would like to see added or a bug. Once reviewed by the program office, issues will be added to the Scrum board's backlog. Developers and tool contributors can then address issues from the backlog and track their status using the Scrum board—providing an Agile approach to development and complete transparency to users.
The backend can be run via Docker. To run the node app locally with Docker, first make sure you have installed and setup the NIEM Movement Docker config:
docker network create niem-network
To generate a new list of nonparentTypes and subGroupHeadIds for the Solr data import, run: node writeSolrIngestFiles.
Note: Also build and run the Solr container. Then build and run the backend container, from the repo's root directory:
docker build -t movement-backend .
docker run -dti -p 7000:7000 --name movement-backend --net niem-network movement-backend
An Express project with the following features:
- Authentication and Session Storage via passport
- Data persistence with MongoDB using the Mongoose ODM
- Example CRUD HTTP endpoints
- Code coverage, unit tests and documentation
- Node.js: 6.9.1 LTS or greater is required
npm install To install the following:
- body-parser - Parses incoming request bodies
- dotenv - Shim to load environment variables from .env into ENV
- express - Web application framework for Node.js
- helmet - Secure Express apps with various HTTP headers
- locreq - Local Require - use relative paths with require for unit tests
- nsp - Node security platform, check for known vulnerabilities
Configure the environmental parameters via the .env file or config them via the command line when running.
Run the application with npm start or with optional parameters PORT=7001 NODE_ENV=development npm start