Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kaggl authored Apr 22, 2024
1 parent 6b01718 commit f5a6f7a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,35 @@

Web frontend for the [MMP project](https://github.com/acdh-oeaw/mmp). Deployed at
<https://mmp.acdh.oeaw.ac.at>.

## How to run
Prerequisites: [Node.js v20](https://nodejs.org/en/download) and [npm v10](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

Set required environment variables in `.env`:

```bash
# Unix
cp .env.local.example .env.local

# Windows
copy .env.local.example .env.local
```

Install dependencies:

```bash
npm i
```

Run a development server on [http://localhost:3000](http://localhost:3000):

```bash
npm run dev
```
Build for production:
```bash
npm run build
```

## How to deploy
Commits pushed to the `main` branch will automatically be deployed to the ACDH-CH cluster via GitHub Actions.

0 comments on commit f5a6f7a

Please sign in to comment.