Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/touhidrahman/nx-starter
Nx powered starter project for Angular with SpartanUI
https://github.com/touhidrahman/nx-starter
Last synced: about 1 month ago
JSON representation
Nx powered starter project for Angular with SpartanUI
- Host: GitHub
- URL: https://github.com/touhidrahman/nx-starter
- Owner: touhidrahman
- Created: 2020-09-14T09:00:30.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T03:59:42.000Z (8 months ago)
- Last Synced: 2024-05-23T04:59:28.152Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.89 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- trackawesomelist - nx-starter (⭐4) - Nx powered starter project for Angular with SpartanUI. (Recently Updated / [Nov 23, 2024](/content/2024/11/23/README.md))
- fucking-awesome-angular - nx-starter - Nx powered starter project for Angular with SpartanUI. (Table of contents / Angular)
- awesome-angular - nx-starter - Nx powered starter project for Angular with SpartanUI. (Table of contents / Angular)
README
# NX Starter
✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨
## Notes
### Common dependencies by Spartan-Ng
- ngx-scrollbar
- embla-carousel
- clsx
## Common Tasks
### Remove spec files
```
find ./apps -type f -name "*.spec.ts" -exec rm -f {} +
find ./libs -type f -name "*.spec.ts" -exec rm -f {} +
```
### Spartan UI Scripts
Update your package.json with following:
```
"spartan1of3": "pnpm add -D @spartan-ng/cli@latest --strict-peer-dependencies",
"spartan2of3": "pnpm add @spartan-ng/ui-core@latest --strict-peer-dependencies",
"spartan3of3": "pnpm dlx nx g @spartan-ng/cli:ui",
```
### Updating spartan UI
- Run `pnpm spartan1of3` to upgrade spartan cli.
- Remove `libs/ui` directory.
- Remove all `@spartan/*` paths from `tsconfig.base.json`.
- Run `pnpm spartan2of3`
- Run `pnpm spartan3of3` and follow instructions. Enter `libs/ui` when asked about install folder. Select `all` components when prompted. (Omit `helm` if you encounter error)
- Finally run `npm run format`
### Setup tailwind for a new project
`npx nx generate @nrwl/angular:setup-tailwind <>`
### Prepare git hooks
Run `npm run prepare` which will create `.husky/precommit` file. Open the file and write `npm run pre-commit`.
## Start the app
To start the development server run `nx serve tailwind-test`. Open your browser and navigate to http://localhost:4200/. Happy coding!
## Generate code
If you happen to use Nx plugins, you can leverage code generators that might come with it.
Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list ` to see what generators are available.
Learn more about [Nx generators on the docs](https://nx.dev/features/generate-code).
## Running tasks
To execute tasks with Nx use the following syntax:
```
nx <...options>
```
You can also run multiple targets:
```
nx run-many -t
```
..or add `-p` to filter specific projects
```
nx run-many -t -p
```
Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks).
## Want better Editor Integration?
Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users.
## Ready to deploy?
Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed.
## Set up CI!
Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further.
- [Set up remote caching](https://nx.dev/features/share-your-cache)
- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution)
- [Learn more how to setup CI](https://nx.dev/recipes/ci)
## Explore the Project Graph
Run `nx graph` to show the graph of the workspace.
It will show tasks that you can run with Nx.
- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph)
## Connect with us!
- [Join the community](https://nx.dev/community)
- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools)
- [Follow us on Twitter](https://twitter.com/nxdevtools)