https://github.com/yorkie-team/dashboard

Dashboard is an administrative tool that allows users to manage projects and documents with ease.
https://github.com/yorkie-team/dashboard

admin-dashboard hacktoberfest yorkie

Last synced: 4 months ago
JSON representation

Dashboard is an administrative tool that allows users to manage projects and documents with ease.

• Host: GitHub
• URL: https://github.com/yorkie-team/dashboard
• Owner: yorkie-team
• License: apache-2.0
• Created: 2022-02-16T01:45:21.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-13T06:41:13.000Z (10 months ago)
• Last Synced: 2024-04-13T17:52:09.649Z (10 months ago)
• Topics: admin-dashboard, hacktoberfest, yorkie
• Language: TypeScript
• Homepage: https://yorkie.dev/dashboard/
• Size: 64.7 MB
• Stars: 19
• Watchers: 8
• Forks: 13
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dashboard

Dashboard is an administrative tool that allows users to manage projects and documents.

## Developing Dashboard

### Building Dashboard

For building dashboard, You'll first need Node.js installed(Node.js version 16+ and npm version 7.10+ are required).

```

# install packages

npm install

# build

npm run build

```

To generate proto messages, we use `protoc-gen-connect-es`, which is a code generator plugin for Protocol Buffer compilers, like buf and protoc. It generates both clients and server definitions from Protocol Buffer schema.

For more details, see [@connectrpc/protoc-gen-connect-es](https://github.com/connectrpc/connect-es/tree/main/packages/protoc-gen-connect-es).

```

# To generate code for all protobuf files within the project

npm run build:proto

```

> Primary "source of truth" location of protobuf message is in [yorkie](https://github.com/yorkie-team/yorkie/tree/main/api). We manage the messages in the repository.

### Running Dashboard

Dashboard needs Yorkie server. We can simply run them using `docker-compose`.

To start Yorkie in a terminal:

```

$ docker-compose -f docker/docker-compose.yml up --build -d

```

In the project directory, you can run:

```

$ npm run dev

```

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details on submitting patches and the contribution workflow.