Web-based app to map squiggles to MEI snippets (under construction)
You can access the public version of the mei-mapping-tool app at https://cress.simssa.ca You can access the development version of the mei-mapping-tool app at https://cress-staging.simssa.ca
- Node.js
- Homebrew for mac users
- Mongodb Make sure MongoDB is installed (
brew install mongodb) - Mongoose
npm install mongoose - npm:
npm install npm@latest -g
To check if you have npm or node.js, you can run these commands in your terminal :
npm -v
node -v
- Clone this repository in your terminal from the
developbranch
git clone https://github.com/DDMAL/mei-mapping-tool
- Go to the mei-mapping-tool repository
cd mei-mapping-tool
- Install dependencies using npm
npm install
- Start the server
npm run dev_start
You should be able to see the message node ./bin/www
If you are seeing errors, such as TypeError: require(...) is not a function in regard to var MongoStore = require('connect-mongo')(session);, package.json dependencies may have been updated to incompatible versions. Delete package-lock.json, revert to the original package.json from this repo, and run npm install again.
You can work on the developement version of the mei-mapping-tool by accessing the page http://localhost:8800/
Depending on your OS, you should follow the instructions to install and run MongoDB as a service upon start.
To install it in Ubuntu 18.04 follow these instructions
If the installation was fine, when opening the terminal window and typing
mongo
you should be able to interact with the database with mongodb commands like show dbsto show a list of all the databases. A list of useful commands can be found in this link : https://docs.mongodb.com/manual/reference/mongo-shell/
- Open the MongoDB compass community application and connect to the
localhost:27017. - Open the Collections tab of the mei-mapping-tool database to see the information from the collections.
For more information about how the application works, you can go to the Cress wiki.
Reporting an issue? Click here!
IP addresses for the server can be found through the lab's Arbutus account with Compute Canada. You need to create an SSH key pair and talk to Alex or Néstor about the local SSH configuration for tunneling (proxy jumping) through a lab computer into the Compute Canada virtual machines. You will only share the PUBLIC KEY (<key_name>.pub not <key_name>) with the individual assisting you.
Your local SSH configuration should look something like this after sending your public key and confirming its configuration:
Host ddmal_<ddmal_member_name>
HostName <ip_addr>
User <name> # username provided to you
IdentityFile ~/cressdev #just a suggested key pair name, put the system path here that leads to it on your local device
# Production #####################
Host nginx.prod
ProxyJump ddmal_<ddmal_member_name>
HostName <ip_addr>
User <name> # same as above
IdentityFile ~/cressdev
Host mei-mapping.production
ProxyJump nginx.prod
HostName <ip_addr>
User <name> # same as above
IdentityFile ~/cressdev
# Staging ########################
Host nginx.staging
ProxyJump ddmal_<ddmal_member_name>
HostName <ip_addr>
User <name>
IdentityFile ~/cressdev
Host mei-mapping.staging
ProxyJump nginx.staging
HostName <ip_addr>
User <name>
IdentityFile ~/cressdev
Inside the production container, the website code is located at /srv/cress/mei-mapping-tool-dev/. The current branch is set to sheet-develop-v1, the current default branch of this repo.
After pulling or updating changes, run the command:
sudo systemctl restart cress-staging.service
The application is always running using this systemd command, and it should restart when there are any unanticipated breaking errors. The systemd script can be found at /lib/systemd/system/cress-staging.service.
To check if the restart worked, run:
sudo journalctl -u cress-staging.service -n 24
to see the last 24 lines of the node logs. Change the number at the end of the previous command if you need to trace back further.
If there is a mongo (database) related error, run the systemd script:
sudo systemctl restart mongod.service
and then run the restart script for cress-staging just to be sure again. Similarly, the systemd script can be found at /lib/systemd/system/mongod.service and its logs can be checked with sudo journalctl -u mongod.service -n 24.
The .env file at the root folder can be configured to run the app on a different port or listen for the mongo database on a different port. It is part of the .gitignore file since the production and staging environments could end up having different configurations.
Inside the production container, the website code is located at /var/lib/cress. The current branch is set to sheet-develop-v1, the current default branch of this repo.
After pulling or updating changes, run the command:
sudo systemctl restart cress.service
The application is always running using this systemd command, and it should restart when there are any unanticipated breaking errors. The systemd script can be found at /lib/systemd/system/cress.service.
To check if the restart worked, run:
sudo journalctl -u cress.service -n 24
to see the last 24 lines of the node logs. Change the number at the end of the previous command if you need to trace back further.
If there is a mongo (database) related error, run the systemd script:
sudo systemctl restart mongod.service
and then run the restart script for cress-staging just to be sure again. Similarly, the systemd script can be found at /lib/systemd/system/mongod.service and its logs can be checked with sudo journalctl -u mongod.service -n 24.
The .env file at the root folder can be configured to run the app on a different port or listen for the mongo database on a different port. It is part of the .gitignore file since the production and staging environments could end up having different configurations.