An open API service indexing awesome lists of open source software.

https://github.com/fairdataihub/dmpchef-website


https://github.com/fairdataihub/dmpchef-website

Last synced: 4 months ago
JSON representation

Awesome Lists containing this project

README

          

# DMP Chef

## Getting started

### Prerequisites/Dependencies

You will need the following installed on your system:

- Node.js
- Yarn
- Docker
- Volta (optional)

### Setup

1. Clone the repository

```bash
git clone git@github.com:fairdataihub/dmp-chef.git
```

2. Install the dependencies

```bash
yarn install
```

3. Add your environment variables. An example is provided at `.env.example`

```bash
cp .env.example .env
```

4. Start the development server

```bash
yarn dev
```

5. Open the application in your browser

```bash
open http://localhost:3000
```

## Development

### Database

The application uses a PostgreSQL database for storing data. You can use Docker to run these services locally.

```bash
docker-compose -f ./dev-docker-compose.yaml up
docker-compose -f ./dev-docker-compose.yaml up -d # if you want the db to run in the background
```

Close the database with:

```bash
docker-compose -f ./dev-docker-compose.yaml down
```

### Prisma

The application uses Prisma to interact with the database.

### UI

The application uses [Nuxt UI](https://ui.nuxt.com) to build the UI components. It also uses [Tailwind CSS](https://tailwindcss.com) for styling.