README.md

CORE About

Static pages for CORE. The project is based on React and Next.js.

Prerequisites

1. Node.js: [download from nodejs.org][node-download] or check the [official installation guidelines][node-package-manager-download] if you prefer using a package manager

2. NPM: usually is installed with Node but you can have a look at the [installation guide][npm-install]

3. NPM_TOKEN: generate a token with the package:read permission at your [GitHub Settings][github-token] and place it into your .bashrc or .zshrc as follows:

   export NPM_TOKEN=<your-token-goes-here>

   The token is needed to enable NPM to download our scoped @oacore packages, deployed to the GitHub Registry.

Getting started

When you pass all Prerequisites you can cd into the project directory and start development as follows:

npm install
npm run dev

Design vendor update

1. Use Node v.16
2. Run npm update @oacore/design

Open localhost:3000 to see the website.

Well done! 🎉

Project structure

The infrastructure and relations between the front-end modules is displayed using the following diagram:

There is a Library Layer providing all shared components for the applications, and an Application Layer which consists of these applications, consuming shared components.

Specifically, this projects requires the [@oacore/design][design] package during the installation stage and depends on [oacore/content][content] and our [API][api] at the build stage.

We use [Netlify CMS][netlify-cms] for editing our content. The CMS pushes changes to some directories at [oacore/content][content].

Also, this projects uses images hosted directly from oacore.github.io/content for simplicity.

Links for help

• github-token

• node-download

• node-package-manager-download

• npm-install

• netlify-cms

• design

• content

• edit content

• api

Thanks ❤️

We support Open Access and Open Source. Many open-source and non-open-source projects help us to deliver our products in great quality.

We give thanks to: