Skip to content

Commit

Permalink
add simple setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JaroCamphuijsen committed Jun 6, 2024
1 parent b5d0edc commit cc75583
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,45 @@
This repository contains the contents for the Research Software Support platform.

This platform uses the [NEBULA framework](https://github.com/esciencecenter-digital-skills/NEBULA).

For elaborate setup instructions and other documentation, see the [NEBULA documentation](https://github.com/esciencecenter-digital-skills/NEBULA-docs)


# Quick local setup

## Content directory/repository

To use NEBULA to build the content in this repository locally, you will need to clone this repository and the NEBULA repository:

```bash
git clone [email protected]:esciencecenter-digital-skills/research-software-support.git
git clone [email protected]:esciencecenter-digital-skills/NEBULA.git
```

## Link to the content repository

To make sure that NEBULA knows where to find the content, we create the following environment variable:

```bash
export CONTENT_PATH="~/path/to/your/content/repository"
```

## Install dependencies

Install the dependencies using the [node package manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm):

```bash
# node package manager
npm install
```

## Local development build

Start the development server on `http://localhost:3000`:

```bash
# node package manager
npm run dev
```

Now you can open a browser and navigate to `http://localhost:3000/research-software-support`

0 comments on commit cc75583

Please sign in to comment.