{"id":22010192,"url":"https://github.com/wojciechmarek/modern-dashboard","last_synced_at":"2025-05-06T18:50:36.505Z","repository":{"id":147129515,"uuid":"594854003","full_name":"wojciechmarek/modern-dashboard","owner":"wojciechmarek","description":"Demo application that shows how to build a modern web application with Angular 16 and NestJS.","archived":false,"fork":false,"pushed_at":"2024-01-08T21:34:23.000Z","size":6019,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T01:51:18.467Z","etag":null,"topics":["angular","bem","cqrs","dark-theme","dashboard","dev-container","docker","flat-design","graphql","mongodb","monolith","monorepo","nestjs","ngrx","ngrx-store","nx","scss","smooth-corners","typescript","ui-design"],"latest_commit_sha":null,"homepage":"https://modern-dashboard-ivory.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wojciechmarek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-29T20:44:02.000Z","updated_at":"2024-07-10T14:28:15.000Z","dependencies_parsed_at":"2024-01-08T22:45:04.926Z","dependency_job_id":null,"html_url":"https://github.com/wojciechmarek/modern-dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wojciechmarek%2Fmodern-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wojciechmarek%2Fmodern-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wojciechmarek%2Fmodern-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wojciechmarek%2Fmodern-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wojciechmarek","download_url":"https://codeload.github.com/wojciechmarek/modern-dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252750335,"owners_count":21798685,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","bem","cqrs","dark-theme","dashboard","dev-container","docker","flat-design","graphql","mongodb","monolith","monorepo","nestjs","ngrx","ngrx-store","nx","scss","smooth-corners","typescript","ui-design"],"created_at":"2024-11-30T02:12:13.645Z","updated_at":"2025-05-06T18:50:36.485Z","avatar_url":"https://github.com/wojciechmarek.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Modern Dashboard\n\nIt is a demo application that shows how to build a modern web application with Angular 16 and NestJS. This project is not an actual application solving any particular business problem. Instead, it is a blueprint that can be used to build an application. For now, it shows how to style the application using the atomic design methodology and how to configure the NX monorepo.\n\n## Purpose\n\nTo learn the Angular 16 and NestJS frameworks and build a modern application with cutting-edge technologies and techniques:\n\n- ✅ using the latest Angular 16 features (standalone components, Signal, etc.),\n- ✅ using the latest NestJS features (GraphQL, etc.),\n- ✅ using the docker containers to develop and run the application,\n- ❌ using the MongoDB database with Change Streams,\n- ❌ using the .env files to store the secrets,\n- ❌ using the CQRS to process the data in the spirit of DDD,\n- ✅ using the atomic design methodology to build the UI,\n- ❌ using the Storybook to present and test the UI components,\n- ❌ using real-time communication with GraphQL subscriptions,\n- ❌ using JWT to authenticate the user,\n- ❌ using Jest and Angular Testing Library to test the Angular components,\n- ✅ using Nx to manage the mono repo (to share code between the front- and back-end, splitting the responsibilities into apps and libs, marking them by scopes and tags).\n\n## Demo\n\nA live demo is available at [https://modern-dashboard-ivory.vercel.app/](https://modern-dashboard-ivory.vercel.app/).\n\n## Screenshots\n\n![demo](./screenshots/demo.png)\n\n![search](./screenshots/search.png)\n\nCurrent dashboard:\n\n- does not use actual data,\n- does not allow to change the language,\n- does not support mobile views (due to the `desktop first approach),\n- allows you to change the color theme and the language.\n\n## Design style\n\nThe application follows the **flat design** style. The main characteristics are:\n\n- avoiding the shadows to highlight the hierarchy, e.g., modal windows (because they introduce a 3rd dimension),\n- playing with the blurs and hues of the colors to show the hierarchy.\n\n## Used technologies\n\n- 🎁 **Repository:** Monorepo with NX\n- 🧰 **Frameworks:** Angular 16, NestJS\n- 🛠️ **Tools:** yarn, eslint, prettier, husky, conventional commits, storybook, docker, graphql, apollo, chart.js\n- 🎨 **Styling:** scss, css variables, BEM notation, lucide icons, smooth-corners\n- 🧪 **Testing:** cypress, jest\n- ☁️ **Database:** MongoDB with Change Streams, typeORM\n- 💎 **Others:** desktop first approach, progressive web app, atomic design\n\n## Storybook\n\nThe Storybook is a sandbox for components used in the application. It groups the into three sections, following the **atomic design** approach:\n\n- atoms (e.g., single buttons or input fields),\n- molecules (e.g., login form consisting of input fields and a submit button),\n- organisms (e.g., most complex views, like login modal window using login form and other molecules).\n\nTo start the Storybook:\n\n1. Type and run: `yarn storybook`.\n2. Open `http://localhost:4004` in your browser to see the storybook.\n\n## How to run\n\nThere are two ways to start a project:\n\n- using a classic Node.js environment installed on the local machine,\n- using a development container (the `devcontainer.json` file in the repo).\n\nThe classic way:\n\n1. Install [node.js](https://nodejs.org/en/download/).\n2. Install [yarn](https://classic.yarnpkg.com/en/docs/install).\n3. Clone the repository.\n4. Type and run: `yarn` in the root directory.\n5. Type and run: `yarn dev` in the root directory.\n6. Open `http://localhost:4200` in your browser to see the frontend app.\n7. Open `http://localhost:3333` in your browser to see the backend app.\n\nThe development container way:\n\n1. Install [VS Code](https://code.visualstudio.com/).\n2. Install and run [Docker](https://www.docker.com/products/docker-desktop).\n3. Install a VS Code [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.\n4. Clone the repository.\n5. Open the repository in VS Code.\n6. Click the `\u003e\u003c` (Open a Remove Window) button in the bottom left corner of the VS Code window.\n7. Select `Reopen in Container`.\n8. Wait for the container to start.\n9. Open a terminal in VS Code (it will be automatically connected to the container's shell).\n10. Type and run: `yarn` in the root directory.\n11. Type and run: `yarn dev` in the root directory.\n12. Open `http://localhost:4200` in your browser to see the frontend app.\n13. Open `http://localhost:3333` in your browser to see the backend app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwojciechmarek%2Fmodern-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwojciechmarek%2Fmodern-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwojciechmarek%2Fmodern-dashboard/lists"}