Skip to content

Historypin/nara-api-eval

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

nara api evaluation

a node.js application written to help evaluate the nara api.

installation

  1. clone the repo to a local project directory
git clone -o github git@github.com:dan-nl/nara-api-eval.git
  1. install dependant node modules in the project directory
cd nara-api-eval
npm install
  1. follow the config instructions.

  2. start the application from the project directory

npm start
  1. open a browser to the application url, https://localhost:3000. note: you may need to accept the self-signed certificate by opening the advanced link.

config

copy the development config example and adjust the username and password as appropriate.

cp app/config/development.example.js app/config/development.js

env variables

there are 4 server environment variables that the application depends on; 3 can be hard coded in the config file or use server environment variables. NODE_ENV must be set as an environment variable. if you hard code the other 3, you don’t need to set them as environment variables.

as a quick reminder, on most linux machines, if your server user uses a bash shell, you can add the following export commands to the .bash_profile file in the user’s home directory in order to have them set for every shell session.

server environment

export NODE_ENV=development

server ip address

export NODE_IP_ADDRESS=''

ssl

the application runs an https server, so it requires an ssl key and crt. this article will help you create a self-signed ssl certificate if needed. then set the following environment variables.

export SSL_KEY=/ssl.key.location
export SSL_CRT=/ssl.crt.location

license

MIT

contributors

dan entous

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors