StateArchivesOfNorthCarolina/ratom-web

Contains the UI code for the RATOM project

Contents

• RATOM Web
• 🌵 created by Caktus Group 🏜
  • Getting Started
• Enable Auto-Linting (VSCode)
• Deployment
• Testing
• License(s)
• Development Team

RATOM Web

🌵 created by Caktus Group 🏜

Below you will find basic setup and deployment instructions for the ratom_api project. To begin you should have the following applications installed on your local development system:

• Python >= 3.7
• NodeJS >= 10.16
• pip >= 19
• virtualenv >= 1.10
• virtualenvwrapper >= 3.0

Getting Started

First clone the repository from Github and switch to the new directory:

$ git clone git@github.com:StateArchivesOfNorthCarolina/ratom-web.git
$ cd ratom_web

Next setup a virtualenv with python 3.7:

$ virtualenv -p `which python3.7` $(WORKON_HOME)/ratom_web

Install the requirements:

$ pip install -r requirements.txt

Finally install node packages and start the server

1. npm i
2. npm run start

Enable Auto-Linting (VSCode)

1. download and enable the following vscode extensions:

• dbaeumer.vscode-eslint
• esbenp.prettier-vscode

2. make sure your vscode workspace contains "editor.formatOnSave": true

• (this should already be set if .vscode is checked in to version control)

Deployment

For deployment documentation, please see the ratom_server repo.

Testing

1. make sure cypress is installed (npm i should do the trick)
2. if not already present, make sure there is a user test@user.com with password testing
3. npm run test

To create new tests, open /cypress/integration and add a yourtests.spec.js file.

License(s)

Logos, documentation, and other non-software products of the RATOM team are distributed under the terms of Creative Commons 4.0 Attribution. Software developed for the RATOM project is distributed under the terms of the MIT License. See the LICENSE file for additional details.

Copyright 2020, The University of North Carolina at Chapel Hill.

Development Team

Developed by Caktus Group for the Review, Appraisal, and Triage of Mail (RATOM) project.

See https://ratom.web.unc.edu/ for RATOM project details, staff bios, and news.