diff --git a/.cspell.json b/.cspell.json index 029995d..fc2849e 100644 --- a/.cspell.json +++ b/.cspell.json @@ -1,6 +1,16 @@ { "language": "en", - "words": ["HackYourFutureBelgium", "HackYourFuture", "Nepo"], + "words": [ + "HackYourFutureBelgium", + "HackYourFuture", + "Nepo", + "Afnan", + "Fadi", + "Bootcamp", + "Ayman", + "Laravel", + "Alnajjar" + ], "ignorePaths": [ "node_modules/**", "package.json", diff --git a/.github/workflows/code-quality-checks.yml b/.github/workflows/code-quality-checks.yml index ea1cb53..e39b2f8 100644 --- a/.github/workflows/code-quality-checks.yml +++ b/.github/workflows/code-quality-checks.yml @@ -1,32 +1,23 @@ name: Code Quality Checks -on: [push, pull_request, workflow_dispatch] +on: + push: + branches: [master, main] + pull_request: + branches: [master, main] jobs: - format_check: + lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - run: npm install - - run: npm run format:check - - spell_check: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - run: npm install - - run: npm run spell-check + - name: Checkout + uses: actions/checkout@v3 - lint_ls: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - run: npm install - - run: npm run lint:ls + - run: npm audit fix - lint_md: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - run: npm install - - run: npm run lint:md + - run: npm run format + - run: npm run format-check # Change format:check -> format-check + - run: npm run spell-check + - run: npm run lint-ls # Change lint:ls -> lint-ls + - run: npm run lint-md diff --git a/README.md b/README.md index 9bdbbee..83358f3 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,25 @@ -# (project name) +# Meet The Team - +We are students in the Post Bachelor Coding Bootcamp, seeking to expand our +knowledge and develop our skills in the software engineering ## Getting Started -1. `git clone git@github.com:HackYourFutureBelgium/.git` +1. `git clone [markDownProject](https://github.com/Zakey-Pilot/markdown-intros)` 2. `cd project-name` 3. `npm install` -## Code Quality Checks +## Code Quality Scripts - `npm run format`: Makes sure all the code in this repository is well-formatted (looks good). -- `npm run lint:ls`: Will lint the folder and file names in this repository to +- `npm run format-check`: Makes sure all the code in this repository is + well-formatted (looks good). +- `npm run lint-ls`: Will lint the folder and file names in this repository to make sure they match the repo conventions. -- `npm run lint:md`: Will lint all of the Markdown files in this repository and +- `npm run lint-md`: Will lint all of the Markdown files in this repository and let you know if there are any style mistakes to fix. - `npm run spell-check`: Goes through all the files in this repository looking for words it doesn't recognize. Just because it says something is a mistake diff --git a/package.json b/package.json index d0e9c48..049ccdd 100644 --- a/package.json +++ b/package.json @@ -4,10 +4,10 @@ "description": "Starter repository for markdown projects at DeNepo", "scripts": { "format": "prettier --write ./", - "format:check": "prettier --check ./", + "format-check": "prettier --check ./", "spell-check": "cspell \"./**\"", - "lint:ls": "ls-lint", - "lint:md": "markdownlint --config ./.markdownlint.jsonc --fix ./ " + "lint-ls": "ls-lint", + "lint-md": "markdownlint --config ./.markdownlint.jsonc --fix ./ " }, "author": "DeNepo", "license": "MIT", diff --git a/people/asmaa.md b/people/asmaa.md new file mode 100644 index 0000000..83358f3 --- /dev/null +++ b/people/asmaa.md @@ -0,0 +1,51 @@ +# Meet The Team + +We are students in the Post Bachelor Coding Bootcamp, seeking to expand our +knowledge and develop our skills in the software engineering + +## Getting Started + + + +1. `git clone [markDownProject](https://github.com/Zakey-Pilot/markdown-intros)` +2. `cd project-name` +3. `npm install` + +## Code Quality Scripts + +- `npm run format`: Makes sure all the code in this repository is well-formatted + (looks good). +- `npm run format-check`: Makes sure all the code in this repository is + well-formatted (looks good). +- `npm run lint-ls`: Will lint the folder and file names in this repository to + make sure they match the repo conventions. +- `npm run lint-md`: Will lint all of the Markdown files in this repository and + let you know if there are any style mistakes to fix. +- `npm run spell-check`: Goes through all the files in this repository looking + for words it doesn't recognize. Just because it says something is a mistake + doesn't mean it is! It doesn't know every word in the world. You can add new + correct words to the [./.cspell.json](./.cspell.json) file so they won't cause + an error. + +## Continuous Integration (CI) + +When you open a PR to `main`/`master` in your repository, GitHub will +automatically do a linting check on the code in this repository, you can see +this in the[./.github/workflows/lint.yml](./.github/workflows/lint.yml) file. + +If the linting fails, you will not be able to merge the PR. You can double check +that your code will pass before pushing by running `npm run lint:md` locally. + +## Repo Setup + +- Give each member **_write_** access to the repo (if it's a group project) +- Turn on GitHub Pages and put a link to your website in the repo's description +- Go to _General_ Section > check **Discussions** +- In the _Branches_ section of your repo's settings make sure the + `master`/`main` branch must: + - "_Require a pull request before merging_" + - "_Require approvals_" + - "_Dismiss stale pull request approvals when new commits are pushed_" + - "_Require status checks to pass before merging_" + - "_Require branches to be up to date before merging_" + - "_Do not allow bypassing the above settings_" diff --git a/people/ayman.md b/people/ayman.md new file mode 100644 index 0000000..5169523 --- /dev/null +++ b/people/ayman.md @@ -0,0 +1,23 @@ +# Hi there, I'm Ayman Alnajjar! ๐Ÿ‘‹ + +--- + +๐ŸŒ About Me I'm a passionate Full-Stack Web Developer from Gaza, Palestine with +a Computer Science degree. I specialize in building web applications with a +strong focus on both front-end and back-end development. + +--- + +๐Ÿ’ป Tech Stack + +๐Ÿ”น Frontend: HTML, CSS, JavaScript, React. + +๐Ÿ”น Backend:PHP(Laravel), Node.js. + +๐Ÿ”น Database: MySQL, PostgreSQL, MongoDB. + +๐Ÿ”น OtherTools: Git,Docker, REST APIs. + +๐Ÿš€ I'm Working On I'm always exploring new technologies and working on exciting +projects to enhance my skills. My main focus is on web development, API +integrations, and scalable applications. diff --git a/people/mohammed.md b/people/mohammed.md new file mode 100644 index 0000000..83358f3 --- /dev/null +++ b/people/mohammed.md @@ -0,0 +1,51 @@ +# Meet The Team + +We are students in the Post Bachelor Coding Bootcamp, seeking to expand our +knowledge and develop our skills in the software engineering + +## Getting Started + + + +1. `git clone [markDownProject](https://github.com/Zakey-Pilot/markdown-intros)` +2. `cd project-name` +3. `npm install` + +## Code Quality Scripts + +- `npm run format`: Makes sure all the code in this repository is well-formatted + (looks good). +- `npm run format-check`: Makes sure all the code in this repository is + well-formatted (looks good). +- `npm run lint-ls`: Will lint the folder and file names in this repository to + make sure they match the repo conventions. +- `npm run lint-md`: Will lint all of the Markdown files in this repository and + let you know if there are any style mistakes to fix. +- `npm run spell-check`: Goes through all the files in this repository looking + for words it doesn't recognize. Just because it says something is a mistake + doesn't mean it is! It doesn't know every word in the world. You can add new + correct words to the [./.cspell.json](./.cspell.json) file so they won't cause + an error. + +## Continuous Integration (CI) + +When you open a PR to `main`/`master` in your repository, GitHub will +automatically do a linting check on the code in this repository, you can see +this in the[./.github/workflows/lint.yml](./.github/workflows/lint.yml) file. + +If the linting fails, you will not be able to merge the PR. You can double check +that your code will pass before pushing by running `npm run lint:md` locally. + +## Repo Setup + +- Give each member **_write_** access to the repo (if it's a group project) +- Turn on GitHub Pages and put a link to your website in the repo's description +- Go to _General_ Section > check **Discussions** +- In the _Branches_ section of your repo's settings make sure the + `master`/`main` branch must: + - "_Require a pull request before merging_" + - "_Require approvals_" + - "_Dismiss stale pull request approvals when new commits are pushed_" + - "_Require status checks to pass before merging_" + - "_Require branches to be up to date before merging_" + - "_Do not allow bypassing the above settings_" diff --git a/people/rahaf.md b/people/rahaf.md new file mode 100644 index 0000000..83358f3 --- /dev/null +++ b/people/rahaf.md @@ -0,0 +1,51 @@ +# Meet The Team + +We are students in the Post Bachelor Coding Bootcamp, seeking to expand our +knowledge and develop our skills in the software engineering + +## Getting Started + + + +1. `git clone [markDownProject](https://github.com/Zakey-Pilot/markdown-intros)` +2. `cd project-name` +3. `npm install` + +## Code Quality Scripts + +- `npm run format`: Makes sure all the code in this repository is well-formatted + (looks good). +- `npm run format-check`: Makes sure all the code in this repository is + well-formatted (looks good). +- `npm run lint-ls`: Will lint the folder and file names in this repository to + make sure they match the repo conventions. +- `npm run lint-md`: Will lint all of the Markdown files in this repository and + let you know if there are any style mistakes to fix. +- `npm run spell-check`: Goes through all the files in this repository looking + for words it doesn't recognize. Just because it says something is a mistake + doesn't mean it is! It doesn't know every word in the world. You can add new + correct words to the [./.cspell.json](./.cspell.json) file so they won't cause + an error. + +## Continuous Integration (CI) + +When you open a PR to `main`/`master` in your repository, GitHub will +automatically do a linting check on the code in this repository, you can see +this in the[./.github/workflows/lint.yml](./.github/workflows/lint.yml) file. + +If the linting fails, you will not be able to merge the PR. You can double check +that your code will pass before pushing by running `npm run lint:md` locally. + +## Repo Setup + +- Give each member **_write_** access to the repo (if it's a group project) +- Turn on GitHub Pages and put a link to your website in the repo's description +- Go to _General_ Section > check **Discussions** +- In the _Branches_ section of your repo's settings make sure the + `master`/`main` branch must: + - "_Require a pull request before merging_" + - "_Require approvals_" + - "_Dismiss stale pull request approvals when new commits are pushed_" + - "_Require status checks to pass before merging_" + - "_Require branches to be up to date before merging_" + - "_Do not allow bypassing the above settings_" diff --git a/planning/backlog.md b/planning/backlog.md new file mode 100644 index 0000000..681c657 --- /dev/null +++ b/planning/backlog.md @@ -0,0 +1,45 @@ +# Backlog + +## Must-Haves + +are necessary for basic usability: + +- **user story name**: As a recruiter I want to view the team description so + that i have a general knowledge about team + - Given I'm in opened browser when I click on the repository link then the + description shows up + - ... +- **user story name**: As a recruiter I want to view the profiles for each + member so that I can view their information + - Given I'm in description screen when I clicks on the profile link then + navigate to profile screen + - ... +- ... + +## Should-Haves + +will complete the user experience, but are not necessary: + +- **user story name**: As a recruiter I want to see the previous work of the + team so that i can discover team experience + - Given I'm in description screen when I clicks on the previous work link then + navigate to previous work screen + - ... + +## Could-Haves + +would be really cool ... if there's time: + +- **user story name**: As a [type of user] I want to [do something] so that [I + achieve some goal] + - Given [context] when [a specific action is performed] then [a set of + consequences should occur] + - ... +- **user story name**: As a [type of user] I want to [do something] so that [I + achieve some goal] + - Given [context] when [a specific action is performed] then [a set of + consequences should occur] + - ... +- ... + +--- diff --git a/planning/communication.md b/planning/communication.md new file mode 100644 index 0000000..bfde8d9 --- /dev/null +++ b/planning/communication.md @@ -0,0 +1,48 @@ +# Communication + +## Group Rules + +- be polite +- be on time + +--- + +## Communication Schedule + +| Day | How | The topic of discussion | +| ------ | :-----: | :----------------------: | +| Monday | 16 - 18 | review the finished task | + +## Communication Channels + +how often will we get in touch on each channel, and what we will discuss there: + +- **Issues**: +- **Pull Requests**: +- **GitHub Discussions** +- **Slack/Discord**: +- **Video Calls**: + +--- + +## Availability + +### Availability for calling/messaging + +| Day | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | +| ----- | :-----: | :-----: | :-------: | :------: | :-----: | :------: | :-----: | +| Ayman | 14 - 18 | 8 - 12 | 14 - 20 | 13 - 20 | 00 - 00 | 12 - 20 | 12 - 18 | + +### How many hours everyone has per day + +- Ayman: _6h_; + +## Asking for Help + +There's a fine line between confidently learning from your mistakes, and +stubbornly getting no where. Here is a general guide for when to ask for help +based on how long you've been stuck on the same problem: + +1. _0 -> 30 min_: Try on your own +2. _30 -> 60 min_: Ask your group for help +3. _60+ min_: Tag your coaches in Slack or GitHub diff --git a/planning/constrains.md b/planning/constrains.md new file mode 100644 index 0000000..a43d8a3 --- /dev/null +++ b/planning/constrains.md @@ -0,0 +1,34 @@ +# Constraints + +Some boundaries around our project. + +## External + +- The deadline +- The template repository restrictions + +## Internal: Involuntary + +- Some of our members have electricity and internet issues +- We can't meet IRL +- Difficulty in arranging an appointment with each other at the same time + + + +## Internal: Voluntary + +- The number of hours you want to spend working +- Making the project in English Language + + diff --git a/planning/user-persona.md b/planning/user-persona.md new file mode 100644 index 0000000..56c6a52 --- /dev/null +++ b/planning/user-persona.md @@ -0,0 +1,31 @@ +# User Personas + +- Technical Recruiter +- Non-Technical Recruiter + +--- + +## Their Role + +- **Bio**:Afnan is a technical project manager from Jordan +- **Needs/Goals**: She wants to recruit a full-time team to build a new web + banking application. +- **Frustrations**:Finding a cohesive and skilled team that can efficiently + complete the project on time. +- **Scenario 1**:Afnan is a project manager at a software house and has been + assigned to hire a development team experienced in Next.js and TypeScript. She + searches online and discovers our teamโ€™s repository on GitHub. After reviewing + our skills and past projects, she finds that we meet the project requirements + and decides to reach out. + +--- + +- **Bio**: Fadi is the CEO of an accounting firm from Palestine. +- **Needs/Goals**: He needs a team to lead a digital transformation initiative + to optimize and modernize his companyโ€™s accounting processes. +- **Frustrations**:Hiring an experienced development team that understands + business needs and can implement an efficient digital solution. +- **Scenario 2**:Fadi is looking to digitalize his accounting firm to improve + workflow and efficiency. A trusted colleague recommends our team. He explores + our repository, reviews our previous work, and finds that we have the + expertise to successfully handle his project.