Skip to content

Commit

Permalink
GH-638 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dzikoysk committed Feb 19, 2021
1 parent 3f98213 commit 4647f7c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 19 deletions.
41 changes: 25 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,42 @@
<h1>Hub
<a href="https://travis-ci.com/panda-lang/hub"><img src="https://travis-ci.com/panda-lang/hub.svg?branch=master" alt="Build Status"></a>
<a href="https://www.codefactor.io/repository/github/panda-lang/hub"><img src="https://www.codefactor.io/repository/github/panda-lang/hub/badge" alt="CodeFactor"></a>
<a href="https://github.com/panda-lang/hub/actions/workflows/gradle.yml"><img src="https://github.com/panda-lang/hub/actions/workflows/gradle.yml/badge.svg" /></a>
<a href="https://travis-ci.com/panda-lang/hub"><img src="https://travis-ci.com/panda-lang/hub.svg?branch=master" alt="Build Status"></a>
<a href="https://www.codefactor.io/repository/github/panda-lang/hub"><img src="https://www.codefactor.io/repository/github/panda-lang/hub/badge" alt="CodeFactor"></a>
</h1>

Panda Hub is the module manager registry for amazing Panda (+JVM) based projects 📜 <br>
~ <a href="https://panda-lang.org/">panda-lang.org</a> :wq

#### 📋 Requirements

#### 🧬 Stack
- Hub Backend: Kotlin + Ktor *(Netty)* + OAuth2 + MongoDB + JUnit
- Hub Frontend: React + Next.js + Chakra UI

#### 📋 Installation
Requirements:

- Java 8+
- Node.js
- MongoDB

#### 💊 Installation
Building from source
Environment variables for server:

```bash
git clone https://github.com/panda-lang/hub.git
cd hub
./start.sh
```conf
GITHUB_CLIENT_ID = $id
GITHUB_CLIENT_SECRET = $secret
```

#### 🧬 Contribute
Details: [Docs](https://github.com/panda-lang/hub/tree/master/docs)
Building from the source:

```bash
hub
+--docs Hub Docs - Details about contributing and specification
+--hub-backend Hub Backend - Java + Spring Boot
+--hub-frontend Hub Frontend - JavaScript + Vue.js
$ git clone https://github.com/panda-lang/hub.git
$ cd hub

# hub-backend (lohalhost:8080)
$ cd hub-backend && ./gradlew run

# hub-frontend (localhost:3000)
$ cd hub-frontend && npm install && npm run dev
```

#### 💞 See also
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
package org.panda_lang.hub

import io.ktor.locations.*
import io.ktor.server.engine.*
import io.ktor.util.*
import java.security.Security

@EngineAPI
Expand Down
1 change: 0 additions & 1 deletion hub-frontend/README.md

This file was deleted.

0 comments on commit 4647f7c

Please sign in to comment.