Angular-Full-Stack
compodoc
Our great sponsors
Angular-Full-Stack | compodoc | |
---|---|---|
4 | 20 | |
1,466 | 3,946 | |
- | 0.3% | |
6.5 | 8.2 | |
3 months ago | 7 days ago | |
TypeScript | TypeScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Angular-Full-Stack
-
Ask HN: What would be your stack if you are building an MVP today?
It depends on the MVP, but I'd (still?) use the MEAN stack with the latest Angular and Node. Expecially because I made a boilerplate [1] that allows me to start any project faster.
-
Angular 15 π
In case someone is interested in starting using Angular from a complete full stack boilerplate, I updated by project to v15: https://github.com/DavideViolante/Angular-Full-Stack
-
Best course to learn Angular
If you want to play a bit with code and see how things are done in practice you can check out Angular Full Stack.
-
I received first-ever donation on my open-source side project and it felt great
I still remember the first donation I received from my project [1] back in 2017, yeah it felt amazing. The person who donated also sent me an email with subject "much thanks".
compodoc
- What documentation generator do you use for Angular libraries?
-
The best Angular 15 Starter Project
β Angular 15 β Angular Material β Unit Testing with Jest β End-to-End Testing with [TestCafΓ©](https://testcafe.io/ β Internationalization with Transloco β Auto documentation with Compodoc β Analyse your project with webpack-bundle-analyzer β Docker β ESLint β Prettier β Commit Linting β AuditJS Audit this application using Sonatype OSS Index β Auto-generate a CHANGELOG with auto-changelog
-
Documentation culture
Properly written code, there are documentation tool like this for Angular and others. https://compodoc.app/
-
Are there any Angular Modules, components, services relationship Mapping tools? Apart from Angular Augury.
Compodoc is a good tool for generating docs for an angular project. The documents generated also includes visual maps of dependencies.
-
I write more documents than code, but it comes with its struggles. Do you feel the same?
App documentation, here is compodoc (https://compodoc.app/) It is generated when the dev does a git commit and build in the pipeline.
-
Documenting Angular projects
Finally, we have come to a point where we want our JSDoc comment documentations to turn into a full scale documentation website, which we can share with new developers instead of providing lengthy Word documents, or which can be used by the team to search for explanations and direction during development. Thankfully, there are amazing tools that help us build such sites easily, with just a console command. Today we will be exploring one such tool called Compodoc, which is a documentation website generator specifically designed for Angular projects (it also supports Nest and Stencil, but we will focus on Angular).
-
Which tool for code documentation has worked best for you in an environment based on Nrwl/Nx, Angular, NestJS and TypeScript?
We use Compodoc in our applications. You write JSDoc comments and it does the hard work of creating the documentation for you.
-
π Angular 13 + ESLint, Material + Transloco + Jest, TestCafe + Docker + Prettier π
npm run compodoc - generate compodoc documentation
-
The best Angular 13 Starter Project
β Angular 13 β Angular Material β Unit Testing with Jest β End-to-End Testing with [TestCafΓ©](https://testcafe.io/ β Internationalization with Transloco β Auto documentation with Compodoc β Analyse your project with webpack-bundle-analyzer β Docker β ESLint β Prettier β Commit Linting β AuditJS Audit this application using Sonatype OSS Index β Auto-generate a CHANGELOG with auto-changelog
-
Architecture Diagraming Tools
Not too sure about a diagramming tool for a new project, but I've used compodoc to automatically generate documentation and diagrams for existing Angular apps before and would definitely recommend checking it out
What are some alternatives?
mockoon - Mockoon is the easiest and quickest way to run mock APIs locally. No remote deployment, no account required, open source.
storybook - π The UI component explorer. Develop, document, & test React, Vue, Angular, Web Components, Ember, Svelte & more! [Moved to: https://github.com/storybookjs/storybook]
generator-ngx-rocket - :rocket: Extensible Angular 14+ enterprise-grade project generator
tsdoc - A doc comment standard for TypeScript
SVG Gauge - Minimalistic, animated SVG gauge. Zero dependencies
ngx-virtual-scroller - Virtual Scroll displays a virtual, "infinite" list.
whisperify - An interactive way to learn about your favourite songs on Spotify. Quiz yourself on your favourite playlists and share quizzes with friends.
vscode-docthis - JSDoc generator extension for Visual Studio Code.
starter-kit - :package: Angular 14+ starter kit for enterprise-grade projects
webpack-bundle-analyzer - Webpack plugin and CLI utility that represents bundle content as convenient interactive zoomable treemap
fastify-typescript-generator - generates new fastify applications in everyone's favourite language typescript with various options to choose from based on your project needs
ESLint - Find and fix problems in your JavaScript code.