This is a Next.js project bootstrapped with create-next-app.

Introduction

This is the consumer site for the Teaching Kit. The data displayed is kept on a Strapi service with this source code.

Initial setup

First, create an .env-file with the keys specified in .env.example. Get the value for each key by someone knowledgeable of the service. It is of course of utter importance that this file remains in the .gitignore.

After having set the environment variables, run:

npm install
npm run dev

In case you have some issues during the setup with Prisma, see the section under the "Database client" heading below.

... and the service should be up and running on http://localhost:3000.

In order for the service to run as expected, it needs data which are supposed to be fetched from Strapi on http://localhost:1337. You can pull the source code for the Strapi project from here.

Database client

For the Zenodo workflow (read more in /docs/zenodo), we use a postgres database to keep track of each entry's upload status. We use Prisma as a database ORM. To get the project running initially, the only thing you should need is to generate the prisma client, which is built-in into our package.json-script for npm run develop, npm run start, and npm run build. If you're working with the Zenodo workflow, you will also need to setup the database locally. You can do this by following the steps in /docs/zenodo/setup.

Styling

We use @emotion/styled-components for styling in this project. In some rare cases we use regular in-line CSS-in-JS in order to adjust external components from e.g Material-UI. In these cases we stick to the CSS-in-JS throughout the whole component.

Hosting

The site is deployed on Vercel.