M3 Developer Tooling and Workflow - ProjectMirador/mirador GitHub Wiki

Background Information (Tooling)

Mirador developers will need to have Node.js and npm installed. Having Node version management software installed is also useful to switch Node.js versions. Checkout Node Version Manager.

First-time Setup

Clone the Repository
git clone [email protected]:ProjectMirador/mirador.git

Install the Dependencies
npm install

Start the Development Server
run npm start. This will start the development server. You should now be able to navigate to localhost:4444 in your browser and see the Mirador workspace running.

Developer Tools Extensions
Mirador uses react for UI rendering, and redux for managing state. It can be very useful to install the related developer tools extensions.

React DevTools for Chrome
React DevTools for Firefox

Redux DevTools for Chrome
Redux DevTools for Firefox

Running Tests
https://github.com/ProjectMirador/mirador/wiki/M3---Testing-hints-and-tricks-for-Mirador-developers