diff --git a/README.md b/README.md index 672c2ca5..fc7ae5bb 100644 --- a/README.md +++ b/README.md @@ -13,28 +13,26 @@ ## What this project is for -A Web Dashboard For [dae](https://github.com/v2raya/dae) +A Web Dashboard for [dae](https://github.com/v2raya/dae) ![preview](public/preview.png) -## Our Goals: +## Features -- Easy to use, with keyboard navigation / shortcuts builtin -- Beautiful and intuitive UI -- Light / Dark mode -- Mobile friendly - -## Contribute to daed - -Feel free to open issues or submit your PR, any feedback or help will be welcome and greatly appreciated +- [x] Easy to use, with keyboard navigation / shortcuts builtin +- [x] Beautiful and intuitive UI +- [x] Light / Dark mode +- [x] Mobile friendly ### How to run and build this project -#### First, we need to get [dae-wing](https://github.com/daeuniverse/dae-wing) up and running, which you can think it as a API center companion of dae +> **Note**: This project is a standaone UI component that works together with [dae-wing](https://github.com/daeuniverse/dae-wing) (backend API server). This project cannot run alone without `dae-wing` since they are bundled as a software stack to interact with [dae](https://github.com/daeuniverse/dae) (core). + +#### Get started with dae-wing Clone `dae-wing` to a remote or local linux environment -```sh +```bash git clone https://github.com/daeuniverse/dae-wing.git cd dae-wing @@ -42,25 +40,24 @@ cd dae-wing Run the make script which will clone the dae repo to a specific folder relative to the working directory -```sh +```bash make deps ``` Build the `dae-wing` binary using go build -```sh +```bash go build . ``` Run the `dae-wing` binary we just built w/o `api-only` mode enabled -```sh +```bash # ./dae-wing -c ./ --api-only - ./dae-wing -c ./ ``` -#### Then, run daed on your local machine +#### Get started with daed Clone this project to your development directory @@ -76,13 +73,11 @@ Install package dependencies using `pnpm` pnpm install ``` -We need to generate graphql type definitions and api bindings +> **Note**: We need to generate graphql type definitions and api bindings +> Use environment variable `SCHEMA_PATH` to specify your schema endpoint +> It can be a url starts with http(s) points to graphql endpoint or a static graphql schema file -Use environment variable `SCHEMA_PATH` to specify your schema endpoint - -It can be a url starts with http(s) points to graphql endpoint or a static graphql schema file - -Optionally, append `-w` or `--watch` at the end of the command to watch upcoming changes +> **Important**: Optionally, append `-w` or `--watch` at the end of the command to watch upcoming changes ```sh # SCHEMA_PATH=http(s)://example.com/graphql pnpm codegen @@ -101,7 +96,16 @@ If everything goes well, open your browser and navigate to http://localhost:5173 Happy Hacking! -### What you need to know + +## Contribute to daed + +Feel free to open issues or submit your PR, any feedbacks or help are greatly appreciated. Special thanks goes to all [contributors](https://github.com/daeuniverse/daed/graphs/contributors). If you would like to contribute, please see the [instructions](./CONTRIBUTING.md). Also, it is recommended following the [commit-msg-guide](./docs/commit-msg-guide.md). + +## License + +[MIT License (C) daeuniverse](https://github.com/daeuniverse/daed/blob/main/LICENSE) + +### Dependencies used in this project - [Graphql](https://graphql.org) - [React](https://reactjs.org)