D-Net
/
openaire-graph-docs
6
1
Fork 5
Code Issues 5 Pull Requests 2 Packages Projects Releases 69 Wiki Activity

Update 'README.md'

This commit is contained in:
Serafeim Chatzopoulos 2023-04-14 14:20:21 +02:00
parent 984bfd6a1b
commit 47ed9d47d5
1 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,33 +2,37 @@
This website is built using [Docusaurus 2](https://docusaurus.io/); please check [here](https://docusaurus.io/docs/installation#requirements) the requirements to run the project.
## Clone repository
```
git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git
```
## Local installation and deployment
## Local installation and development
From https://docusaurus.io/docs/installation#requirements
> Node.js version 16.14 or above (which can be checked by running node -v)
Clone the repository:
```
git clone https://code-repo.d4science.org/D-Net/openaire-graph-docs.git
```
NOTE: please use git branches for introducing new changes.
To install the required packages use:
Install the required packages:
```
npm install
```
The following command starts a local development server and opens up a browser window. Note that most changes are reflected live without having to restart the server.
Start a local development server (opens in a new browser window).
```
npm run start
```
NOTE: most changes are reflected live without having to restart the server.
Generate the static content into the `build` directory using the command tha follows. Then this directory can be served using any static contents hosting service.
Before issueing a Pull Request, please ensure that the following command runs successfully:
```
npm run build
```
NOTE: This command generates the static content into the `build` directory.
Then this output directory is issued to deploy the documentation website.
## Deployment using Docker