eduWRENCH
Running the Application
Local installation
Dependencies:
Run the build script (compiles all simulators, and configures web application):
$ ./build.sh
Start the backend server:
$ cd server
$ node app.js
Start the frontend application:
$ cd web
$ gatsby develop
Open a Web browser and navigate to http://localhost:8000
Running with Docker
Dependencies:
$ docker pull wrenchproject/eduwrench:latest
$ cd eduwrench
$ docker-compose build --no-cache
$ docker-compose up -d
Enabling SSL deployment
By default, eduWRENCH is configured to run in SSL disabled mode. SSL
support can be enabled by editing the .env
file. The following variables
need to be defined to enable SSL support:
# Port number for Gatsby application (frontend)
EDUWRENCH_GATSBY_PORT=443
# Enable SSL connection (true|false)
EDUWRENCH_ENABLE_SSL=true
# Folder where certificates are stored in the local system
EDUWRENCH_SSL_CERTS_DIR=./ssl
# Name of the certificate file
EDUWRENCH_SSL_CERTIFICATE=cert.pem
# Name of the private key file
EDUWRENCH_SSL_PRIVATE_KEY=key.pem
If running the Local installation, the environment should be set by
running the following command: $ source .env
. If running with Docker
no additional steps are required, since the .env
file is automatically
read by the docker-compose
command.
Get in Touch
The main channel to reach the eduWRENCH team is via the support email: support@wrench-project.org.
Bug Report / Feature Request: our preferred channel to report a bug or request a feature is via WRENCH's Github Issues Track.
Funding Support
eduWRENCH has been funded by the National Science Foundation (NSF).