Skip to content

Commit

Permalink
Replace default README
Browse files Browse the repository at this point in the history
  • Loading branch information
aMytho committed Apr 12, 2023
1 parent 4f895b7 commit a1a1c54
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,30 @@ This project was generated with [Angular CLI](https://github.com/angular/angular

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests
## Assets

Most cases are markdown files. They can be found in `src/assets/posts`. The guides are not markdown. They are found in the `src/app/guide` folder.

## Structure

Tailwind Styles (Color Themes)
- `tailwind.config.ts`

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
Assets (Markdown Documents)
- `src/assets/posts`

## Running end-to-end tests
Cases (Includes side bar, main page, and loader)
- `src/app/case`

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
Guide (Content, Routing)
- `src/app/guide`

## Further help
Markdown Loader
- `src/app/globalAccess` and `src/app/md`

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
Alternative Services
- `src/app/info/alt-services`

0 comments on commit a1a1c54

Please sign in to comment.