Arkheia

Arkheia is a MERN application responsible for the analyzation of simulation results with the following prerequisites:

• Node.js: v20.7.0 or later (Use Nodeman for easy management)
• MongoDB: v2.0.0 or later
• Next.js: v13.4.19 or later
• npm: v9.6.5 or later
• Docker and Docker Compose (optional for containerized setup)

Installation

Clone the Repository

git clone https://github.com/NoPleaseNorbi/Arkheia.git

Install Dependencies

Firstly run this in the root directory to install the dependencies for the whole project:

npm install

This project uses concurrently to manage multiple npm scripts. To install all dependencies for both frontend and backend, run:

npm run set-up-frontend
npm run set-up-backend

Running the Application

There are three ways to start the application:

1. Using npm scripts (locally):

   Start the database, frontend, and backend concurrently from the root of the project:

   npm start

2. Using Docker:

   Before using Docker, make sure to update the .env file:

   PORT=4000
   MONGODB_URI=mongodb://database/ArkheiaData
   MONGODB_TEST_URI=mongodb://database/ArkheiaTestDB
   

   And update the proxy in the frontend's package.json:

   "proxy": "http://arkheia-node-server:4000",

   Then, you can use Docker Compose to start the application:

   docker-compose up

3. Manually starting the frontend and backend:

   • To start the frontend:

     cd frontend
     npm start

   • To start the backend:

     cd server
     npm start

Deployment

Before using Docker as a deployment, make sure to update the .env file in the server:

PORT=4000
MONGODB_URI=mongodb://database/ArkheiaData
MONGODB_TEST_URI=mongodb://database/ArkheiaTestDB

You must also update the .env file in the fronend:

REACT_APP_API_URL=http://example.com:4000

And update the proxy in the frontend's package.json:

"proxy": "http://example.com:4000",

Then, you can use Docker Compose to start the application:

docker-compose up

Testing

To run the tests, make sure the backend server is not running and that the database is still running. From the root directory, run:

npm run test

Accessing files through SSHFS

To access simulation results on a file system mounted with sshfs, you'll need to mount it with the following command:

sshfs [user@]host:[remote_directory] path/to/mountpoint -o uid=$(id -u),gid=$(id -g)