https://github.com/jwizard-bot/jwizard-web
JWizard websites monorepo. Including landing-page (SSR) and dashboard (CSR) apps. Next.js and React ecosystem.
https://github.com/jwizard-bot/jwizard-web
chadcn-ui docker jwizard-bot monorepo next react typescript webpack
Last synced: 11 months ago
JSON representation
JWizard websites monorepo. Including landing-page (SSR) and dashboard (CSR) apps. Next.js and React ecosystem.
- Host: GitHub
- URL: https://github.com/jwizard-bot/jwizard-web
- Owner: jwizard-bot
- License: agpl-3.0
- Created: 2024-01-18T16:18:46.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-19T01:51:01.000Z (about 1 year ago)
- Last Synced: 2025-05-19T02:48:02.330Z (about 1 year ago)
- Topics: chadcn-ui, docker, jwizard-bot, monorepo, next, react, typescript, webpack
- Language: TypeScript
- Homepage: https://jwizard.pl
- Size: 4.35 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
JWizard is an open-source Discord music bot handling audio content from various multimedia sources
with innovative web player. This repository contains monorepo with landing page and dashboard
front-end applications with shared configuration and components library.
[[About project](https://jwizard.pl/about)]
Landing page:
[[Docker image](https://hub.docker.com/r/milosz08/jwizard-landing-page)]
| [[Docker installation](./docker/landing-page/README.md)]
Dashboard:
[[Docker image](https://hub.docker.com/r/milosz08/jwizard-dashboard)]
| [[Docker installation](./docker/dashboard/README.md)]
## Table of content
* [Project modules](#project-modules)
* [Clone and install](#clone-and-install)
* [License](#license)
## Project modules
| Name | Description |
|----------------------------|----------------------------------------------------------------------------|
| apps/dashboard | React SPA application for managing guilds. |
| apps/landing-page | Next.js SSR application for root JWizard page. |
| i18n-translations | I18n translations content shared between apps. |
| packages/assets | Static resources (images, fonts) shared between apps. |
| packages/eslint-config | Eslint configurations shared between apps and packages. |
| packages/lib | Typescript shared library (excluding React stuff). |
| packages/prettier-config | Prettier configuration shared between apps and packages. |
| packages/tailwind-config | Tailwind configuration shared between apps. |
| packages/typescript-config | Typescript TSC config shared between apps and packages. |
| packages/ui | React library including widgets, components and hooks shared between apps. |
## Clone and install
1. Make sure you have at least JDK 17, Kotlin 2.0 and Node v20.
2. Go to [jwizard-lib](https://github.com/jwizard-bot/jwizard-lib), configure and run all necessary
containers defined in `README.md` file in this repository. You must have up these containers:
| Name | Port(s) | Description |
|------------------|------------|---------------------------------------|
| jwizard-vault | 8761 | Secret keys storage service. |
| jwizard-mysql-db | 8762 | MySQL database. |
| jwizard-rabbitmq | 8771, 8772 | RabbitMQ server and management panel. |
3. Prepare and run JWizard API and Core projects. For more details, please visit this readme files:
* [Readme file for JWizard Core](https://github.com/jwizard-bot/jwizard-core/blob/master/README.md),
* [Readme file for JWizard API](https://github.com/jwizard-bot/jwizard-api/blob/master/README.md).
4. Clone this repository via:
```bash
$ git clone https://github.com/jwizard-bot/jwizard-web
```
5. Install all monorepo dependencies via:
```bash
$ yarn install --frozen-lockfile
```
> [!TIP]
> If you don't have yarn yet, install via: `npm i -g yarn`.
6. To run selected app from monorepo, type:
```bash
$ yarn run :dev
```
where `` is `landing-page` or `dashboard` (see table above).
By default, applications will be listening at:
| Name | Port | Link |
|--------------|------|-----------------------------------------|
| landing-page | 8763 | [localhost:8763](http://localhost:8763) |
| dashboard | 8764 | [localhost:8764](http://localhost:8764) |
> [!TIP]
> Alternatively you can run selected project via prepared Intellij Idea run configuration.
## Contributing
We welcome contributions from the community! Please read our [CONTRIBUTING](./CONTRIBUTING.md) file for
guidelines on how to get involved.
## License
This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.