researchspace

(★ 140)

ResearchSpace Platform

파일 수가 많아 일부만 표시됩니다. 전체 파일은 위 다운로드 버튼으로 확인해 주세요.

  • .editorconfig
  • .eslintrc.js
  • .gitattributes
  • .gitignore
  • .prettierrc.js
  • ACKNOWLEDGMENTS.md
  • build.gradle
  • CHANGELOG.md
  • components.json
  • CONTRIBUTING.md
  • COPYING
  • COPYING.GPLv3
  • gradle-local.properties.template
  • gradle.properties
  • gradlew
  • gradlew.bat
  • Java11PrerequisitesCheckAndInstallationSteps.md
  • jetty-env.xml
  • LICENSE
  • NOTICE
  • package-lock.json
  • package.json
  • README.md
  • release-notes.md
  • settings.gradle

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/researchspace/researchspace

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd researchspace

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
The creation of the platform Docker image consists of packaging the ResearchSpace platform as a Java webapp (the .war file we have just created) in a Java servlet container, Jetty.

이 명령어를 터미널에 그대로 입력해 실행하세요.

Dockerfile file is located in `dist/docker` folder. This file contains the instructions for building the platform's Docker image that is based on an official Jetty server as image.

이 명령어를 터미널에 그대로 입력해 실행하세요.

**Copy artifacts to docker folder**

이 명령어를 터미널에 그대로 입력해 실행하세요.

<img src="https://img.shields.io/badge/docker-researchspace%2Fplatform--ci%3Alatest-blue" height="30px"></a>

이 명령어를 터미널에 그대로 입력해 실행하세요.

* [Docker Image](#docker-image)

이 명령어를 터미널에 그대로 입력해 실행하세요.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Gradle (Java/Kotlin)

보통
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
  • Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.
* JDK 21 LTS. For historical reasons, ResearchSpace can be built only with Java 11, but the [Gradle Toolchain](https://docs.gradle.org/current/userguide/toolchains.html) feature is used to automatically install the required JDK. JDK 21 is required to run the current version of the `gradle` build tool.

Gradle로 빌드를 진행합니다.

For security, sensitive configuration like passwords and API keys should not be hardcoded in `build.gradle`. Instead:

Gradle로 빌드를 진행합니다.

1. **Copy the template**: `cp gradle-local.properties.template gradle-local.properties`

Gradle로 빌드를 진행합니다.

2. **Fill in your secrets**: Edit `gradle-local.properties` with real credentials

Gradle로 빌드를 진행합니다.

The build system automatically loads all properties from `gradle-local.properties` and makes them available as system properties. You can add any new secrets without modifying the build file.

Gradle로 빌드를 진행합니다.

BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Node.js

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
Running `./gradlew test` command will execute all backend tests (Java JUnit) as well as client-side unit tests (using mainly mocha, chai, sinon). To just execute the client-side test, you can also run `npm run test`. We also have a number of integration tests, see `integration-tests`.

Gradle로 빌드를 진행합니다.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation