-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Welcome to the flowbite-angular wiki! | ||
|
||
> [!WARNING] | ||
> You will only find technical documentation here. To see the library documentation, how to install / use it on angular projets, please go on the [library documentation](https://flowbite-angular.com) | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributors | ||
|
||
If you want to contribute to the project, you will need to follow some rules [described here](https://raw.githubusercontent.com/themesberg/flowbite-angular/refs/heads/main/CODE_OF_CONDUCT.md). | ||
|
||
## BUILD-TOOLS | ||
|
||
To contribute, you will need (of course) to be able to build and start the documentation locally ; here's how : | ||
|
||
1. Make sure you have `Node.js > v20` installed | ||
2. Run `git clone https://github.com/themesberg/flowbite-angular.git` | ||
3. Run `npm i` | ||
> [!WARNING] | ||
> If some errors happen, check the logs ; it could be some dependencies outside Node.js (example with [parcel library](https://github.com/parcel-bundler/watcher) ; this library needs a C++ compiler installed on the computer) | ||
4. Run `npm run docs:serve` | ||
> [!TIP] | ||
> This will start local dev server on `localhost:4200` | ||
## How can I contribute | ||
|
||
You won't be able to create branches inside the `flowbite-angular` repository. Instead, you can create a `fork` of the project, work on this fork and then create a `Pull Request`. You can see the complete documentation in the [GitHub documentation](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Technical information | ||
|
||
## [Workflow process](workflow-process/README.md) | ||
|
||
> [!NOTE] | ||
> Workflow process describe every automation from CD/CI to deployment to [Vercel](http://vercel.com) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Workflow process | ||
|
||
## BASE | ||
|
||
> [!NOTE] | ||
> BASE workflow are defined to be used as often as we can. They provide a single way to do basic operations. | ||
- [BASE - LIB - build & test](base/lib/build%20&%20test.md) | ||
- [BASE - DOC - build & test](base/doc/build%20&%20test.md) |
11 changes: 11 additions & 0 deletions
11
docs/files/technical-information/workflow-process/base/doc/build & test.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
|
||
BUILD_COMMAND : `npm run docs:build` | ||
|
||
UT_COMMAND : `npm run docs:test` | ||
|
||
E2E_COMMAND : `npm run ...` | ||
|
||
--- | ||
|
||
![build & test.png](build%20&%20test.png) |
Binary file added
BIN
+22.5 KB
docs/files/technical-information/workflow-process/base/doc/build & test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions
9
docs/files/technical-information/workflow-process/base/lib/build & test.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
|
||
BUILD_COMMAND : `npm run all:build` | ||
|
||
UT_COMMAND : `npm run lib:test` | ||
|
||
--- | ||
|
||
![build & test.png](build%20&%20test.png) |
Binary file added
BIN
+20.5 KB
docs/files/technical-information/workflow-process/base/lib/build & test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.