vcgit-forge/angular-challenges
1
0
Fork 0
mirror of https://github.com/Raghu-Ch/angular-challenges.git synced 2026-02-10 04:43:03 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: create-challenge-typos & extra clarification

Browse Source
This commit is contained in:
jdegand
2024-04-10 22:55:17 -04:00
parent 5413b9e337
commit e3aa422a66
1 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/src/content/docs/guides/create-challenge.md
View File

@@ -4,17 +4,20 @@ description: Guide to create your own challenge
contributors:
- tomalaforge
- gsgonzalez88
- jdegand
sidebar:
order: 5
---
You have an idea you want to share, an interesting bug you are struggling with in one of your private or side project, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others.
You have an idea you want to share, an interesting bug you are struggling with in one of your private or side projects, or an Angular trick you discovered. All of these possibilities are a good starting point to create a challenge and share the solution with others.
But how do you start creating these challenges?
How do you start creating these challenges?
## Boilerplate Setup
To streamline the process, I have created an Nx generator that will set up all the boilerplate for you and get you ready faster. The easiest way to run it is by using the Nx console: go to the <b>Nx Console > generate > @angular-challenges/cli - challenge</b>
To streamline the process, I have created an Nx generator that will set up all the boilerplate for you. The easiest way to run it is by using the Nx console: go to the <b>Nx Console > generate > @angular-challenges/cli - challenge</b>.
Alternatively, you may utilize your IDE's [Nx Console extension](https://nx.dev/getting-started/editor-setup) to generate the files.
### Parameters
@@ -28,23 +31,23 @@ To streamline the process, I have created an Nx generator that will set up all t
- <b>challengeDifficulty</b>: The difficulty you think your challenge has. There are three difficulty levels : 🟢 easy / 🟠 medium / 🔴 hard
- <b>name</b>: name of the Nx application.
:::note
It must be written in **kebab-case**
It must be written in **kebab-case**.
:::
- <b>docRepository</b>: The category of your Challenge: Nx, Angular, Angular Performance, Rxjs, NgRx, Typescript.
- <b>docRepository</b>: The category of your Challenge is Nx, Angular, Angular Performance, Rxjs, NgRx, Typescript, or Forms.
#### optional parameters
- <b>directory</b>: If you want your application to be located in a specific folder inside `apps`.
- <b>addTest</b>: If you want to add test configuration.
### What is created
### What is created?
- The generator will create all the files needed to have a new working application. All these files will be created inside `apps/${directory}/${name}`
- A Markdown file with the minimal setup will be created inside `docs/src/content/docs/challenges/${docRepository}`
- The generator will create all the files needed to have a new working application. All these files will be created inside `apps/${directory}/${name}`.
- A Markdown file with minimal setup will be created inside `docs/src/content/docs/challenges/${docRepository}`.
## Challenge Creation
The only thing left to do is to create your challenge. 🚀
The only thing left to do is create your challenge. 🚀
:::danger
Don't forget to update the docs to introduce your challenge and provide your instructions.
@@ -52,6 +55,6 @@ Don't forget to update the docs to introduce your challenge and provide your ins
It's your turn to act!!! 💪
## Solution Submittion
## Solution Submission
After one week or so, don't forget to provide your solution to your challenge.
After one week or so, provide a pull request of your solution to your challenge.