https://github.com/sintef/pds_hb_be

https://github.com/sintef/pds_hb_be

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/sintef/pds_hb_be
• Owner: SINTEF
• Created: 2020-11-13T11:52:44.000Z (about 4 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-06T16:17:30.000Z (almost 2 years ago)
• Last Synced: 2023-05-23T21:30:06.328Z (over 1 year ago)
• Language: TypeScript
• Size: 1.22 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Back-end for PDS data handbook

This repository includes the complete back-end for the PDS data handbook application. It includes every endpoint and associated controller, as well as every database model. This README will act as a guide for how to install the back-end and how to run both the server and the tests.

## Installation

### Clone repository

Note: Make sure to have [git](https://git-scm.com/). This can be verified by typing `git --version` in your terminal.

Clone the repository by your method of choice. To clone with HTTPS, open your terminal and navigate to the directory in which you want to clone the project. Type:

```

git clone https://github.com/SINTEF/pds_hb_be.git

```

### Install dependencies

Note: Make sure to have [node](https://nodejs.org/en/download/). This can be verified by typing `npm --version`in your terminal.

In your terminal, navigate to the root directory of the repository you just cloned and type:

```

npm install

```

## Usage

To run the entire application, see [front-end README](https://github.com/SINTEF/pds_hb/blob/development/README.md)

### Running the server

To run the back-end of the PDS data handbook, navigate to the root folder and type:

```

npm start

```

_NB: The server will not run if you do not have the environment variables. For the staff of TDT4290, the envionment variables can be found in the repport appendix in the section called "README for Front-end and Back-end". In your local repository navigate to the .env file, found in the path `\src\config\.env`, and simply paste the variables found in the appendix. They should be on the format:_

_SECRET_KEY=..._

_mongoURI=..._

_mongoURITest=..._

_PORT=5000_

### Running the tests

To run the test of the back-end, navigate to the root folder and type:

```

npm test

```