Skip to content

README.md

Latest commit

 

History

History
79 lines (61 loc) · 1.91 KB

README.md

File metadata and controls

79 lines (61 loc) · 1.91 KB

Get started with the DOME Registry

Our repository is devided into 3 parts:

  • dome-registry-core (shared logic between frontend and backend)
  • dome-registry-ui (backend)
  • dome-registry-ws (frontend)

Installation

Clone the github Repository

git clone git@github.com:BioComputingUP/dome-registry.git
cd dome-registry

1. Install dependencies for dome-registry-core

cd dome-registry-core/
nvm use
npm install
# Create a symlink in the global node_modules
npm link
cd ..

2. Install dependencies for dome-registry-ui

cd dome-registry-ui/
nvm use
npm install
#Link the core repo for the connection between the frontend and the backend
npm link dome-registry-core
cd ..

Build UI (to be served by Apache or nginx)

npm run build-dev
# This command will produce a 'dist' folder with index.html and associated files. Point the Apache virtual host or nginx server block to the 'dist' folder to serve it properly in a production environment

3. Install dependencies for dome-registry-ws

cd dome-registry-ws/
nvm use
npm install
# Link the core repo for the connection between the frontend and the backend
npm link dome-registry-core
cd ..

launching the frontend and the backend

frontend

cd dome-registry-ui
nvm use
npm run start-dev
# open http://localhost:4200/

Backend

cd dome-registry-ws
nvm use
npm run start:dev

Styling System

The DOME Registry uses a comprehensive SCSS-based styling system located in dome-registry-ui/src/styles/. This system includes variables, mixins, and component-specific styles to maintain a consistent look and feel across the application. For more information on how to use the styling system, please refer to the styles README.

License

MIT