From 1ae57cbee541ff14b6819b31f7a7a33b765f3aa3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Mon, 25 Sep 2023 14:47:03 +0200 Subject: [PATCH 1/8] docs: add code of conduct --- CODE_OF_CONDUCT.md | 130 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 130 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b4fe2eae --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,130 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +- Demonstrating empathy and kindness toward other people +- Being respectful of differing opinions, viewpoints, and experiences +- Giving and gracefully accepting constructive feedback +- Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +- Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +- The use of sexualized language or imagery, and sexual attention or advances of + any kind +- Trolling, insulting or derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or email address, + without their explicit permission +- Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[hello@case.app](mailto:hello@case.app). +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq From 21a834f0d95601114629345a8966e5071929b425 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Mon, 25 Sep 2023 14:48:08 +0200 Subject: [PATCH 2/8] docs: update contributing.md --- CONTRIBUTING.md | 85 ++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 73 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 10d62396..bc22293a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,18 +1,77 @@ # CASE Contribution -## client app +First off all, thanks you very much for contribute and Happy Hacktoberfest ! πŸŽ‰ + +[CASE](https://case.app/) is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing on the data. + +The following is a set of guidelines for contributing to CASE and its packages, which are hosted in the [CASE Organization](https://github.com/casejs) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. + +#### Table Of Contents + +[Code of Conduct](#code-of-conduct) + +[How Can I Contribute?](#how-can-i-contribute) + +- [Reporting Bugs](#reporting-bugs) +- [Suggesting Enhancements](#suggesting-enhancements) +- [Your First Code Contribution](#your-first-code-contribution) +- [Pull Requests](#pull-requests) + +[Serve CASE in contribution mode](#serve-case-in-contribution-mode) +[Publish your contribution](#publish-your-contribution) + +## Code of Conduct + +This project and everyone participating in it is governed by the [CASE Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@case.app](mailto:hello@case.app). + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for CASE. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:. + +When you are creating a bug report, please include as many details as possible. Fill out [the required template](.github/ISSUE_TEMPLATE/πŸ›-bug-report.md), the information it asks for helps us resolve issues faster. + +> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for CASE, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand and find your suggestion :pencil: :mag_right:. + +When you are creating an enhancement suggestion, please include as many details as possible. Start a new discussion by following [the template](.github/ISSUE_TEMPLATE/config.yml), including the steps that you imagine you would take if the feature you're requesting existed. + +### Your First Code Contribution + +Unsure where to begin contributing to CASE ? You can start by looking through these `good first issue` and `help wanted` issues: + +### Pull Requests + +The process described here has several goals: + +- Maintain CASE's quality +- Fix problems that are important to users +- Engage the community in working toward the best possible CASE +- Enable a sustainable system for CASE's maintainers to review contributions + +Please follow these steps to have your contribution considered by the maintainers: + +1. Follow all instructions in [the template](.github/pull_request_template.md) +2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing ?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+ +While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. + +## Serve CASE in contribution mode To run the client app on `http://localhost:4200`: ```bash +#From root of the repo. cd packages/case/client npm install ng serve --configuration=contribution ``` -## server app - -``` +```bash # From packages/case/server npm i npm run start:dev @@ -21,31 +80,33 @@ npm run start:dev npm run seed:dev ``` -The folder `packages/case/server/src/_contribution-root` replicates the app root folder of the `CASE Starter` repo. +You have to generate users credentials by seeding data to be able to auth with. -## Contribute working from starter +The folder `packages/case/server/src/_contribution-root` replicates the app root folder of the `CASE Starter` repo. Using `npm link` you can link your `/node_modules/@casejs/case` to the `dist` folder in your project made with CASE starter. -``` +```bash +#From this repo CASE. cd server/dist -# may require sudo +# May require sudo. npm link ``` -Then go to your case starter project and run +Then go to your CASE starter project and run : -``` +```bash +#From your CASE starter project. npm link @casejs/case npm start ``` -## Publish +## Publish your contribution Update the version number in `package.json` and run: -``` +```bash npm run build cd server/dist npm publish From 2e158957c66a8d7910342efbdbfc8a946dc590c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Mon, 25 Sep 2023 15:16:02 +0200 Subject: [PATCH 3/8] docs : add a humans.txt file --- humans.txt | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 humans.txt diff --git a/humans.txt b/humans.txt new file mode 100644 index 00000000..9d3c1299 --- /dev/null +++ b/humans.txt @@ -0,0 +1,49 @@ +# CASE Project - Humans.txt + +The CASE project is made possible by the collaborative efforts of individuals from around the world. We'd like to express our heartfelt gratitude to all those who have contributed their time, skills, and passion to make CASE a reality. You are the lifeblood of this project, and we couldn't have done it without you. + +### Core Team + +- **SΓ©bastien Conejo** (@sebconejo) + - Project Lead + - GitHub: [https://github.com/SebConejo](https://github.com/SebConejo) + +- **Bruno** (@brunobuddy) + - Lead Developer + - GitHub: [https://github.com/brunobuddy](https://github.com/brunobuddy) + +- **IsmaΓ«l Guerrib** (@ismaelguerrib) + - Developer + - GitHub: [https://github.com/ismaelguerrib](https://github.com/ismaelguerrib) + +### Contributors + +Our project has received invaluable contributions from developers, designers, and enthusiasts worldwide. We are deeply grateful for your dedication and support. Here are some of our amazing contributors (in alphabetical order): + +- **Nilay Nath Sharan** (@SubstantialCattle5) + - GitHub: [https://github.com/SubstantialCattle5](https://github.com/SubstantialCattle5) + + +### Special Thanks + +We'd like to extend our special thanks to the following individuals and organizations for their support, advice, and contributions: + +- **Open Source Community** + - Your spirit of collaboration and shared knowledge inspire us every day. + +- **Our Users** + - Your feedback and enthusiasm drive us to continually improve CASE. + + + +### Join Us + +CASE is an open-source project, and we welcome contributions from anyone who shares our vision. If you'd like to get involved or have ideas for improvement, please reach out to us. + +- [Contribute to CASE](https://github.com/casejs/CASE) + +### License + +This work is licensed under the [MIT License](https://opensource.org/licenses/MIT). + +Thank you for being a part of the CASE community! From 568749116cac372510b2e2c8fc36660cdf616647 Mon Sep 17 00:00:00 2001 From: Bruno Date: Mon, 25 Sep 2023 17:07:08 +0200 Subject: [PATCH 4/8] feat(console): prevent ambiguity when starting server app on contribution mode --- packages/case/server/src/app.module.ts | 46 ++++++++++++++++---------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/packages/case/server/src/app.module.ts b/packages/case/server/src/app.module.ts index 6b302e42..eb7e5f68 100644 --- a/packages/case/server/src/app.module.ts +++ b/packages/case/server/src/app.module.ts @@ -1,15 +1,15 @@ -import { Module } from '@nestjs/common'; -import { ConfigModule, ConfigService } from '@nestjs/config'; -import { TypeOrmModule } from '@nestjs/typeorm'; -import * as chalk from 'chalk'; -import * as cliTable from 'cli-table'; -import { DataSource } from 'typeorm'; +import { Module } from '@nestjs/common' +import { ConfigModule, ConfigService } from '@nestjs/config' +import { TypeOrmModule } from '@nestjs/typeorm' +import * as chalk from 'chalk' +import * as cliTable from 'cli-table' +import { DataSource } from 'typeorm' -import { AppConfigModule } from './app-config/app-config.module'; -import { AuthModule } from './auth/auth.module'; -import configuration from './configuration'; -import { DynamicEntityModule } from './dynamic-entity/dynamic-entity.module'; -import { FileUploadModule } from './file-upload/file-upload.module'; +import { AppConfigModule } from './app-config/app-config.module' +import { AuthModule } from './auth/auth.module' +import configuration from './configuration' +import { DynamicEntityModule } from './dynamic-entity/dynamic-entity.module' +import { FileUploadModule } from './file-upload/file-upload.module' const contributionMode: boolean = process.argv[2] === 'contribution' @@ -52,8 +52,11 @@ export class AppModule { head: [] }) + if (!contributionMode) { + table.push(['client URL', chalk.green(`http://localhost:${port}`)]) + } + table.push( - ['client URL', chalk.green(`http://localhost:${port}`)], ['database path', chalk.green(databaseConfig.database)], [ 'entities', @@ -68,11 +71,20 @@ export class AppModule { console.log(table.toString()) console.log() - console.log( - chalk.blue( - 'πŸŽ‰ CASE app successfully started! See it at', - chalk.underline.blue(`http://localhost:${port}`) + + if (!contributionMode) { + console.log( + chalk.blue( + 'πŸŽ‰ CASE app successfully started! See it at', + chalk.underline.blue(`http://localhost:${port}`) + ) ) - ) + } else { + console.log( + chalk.blue( + 'πŸ› οΈ CASE server app successfully started in contributor mode! Do not forget to launch the client app too.' + ) + ) + } } } From 6c3bd5469001f59e26a34ca3282e3da3ba307a4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Mon, 25 Sep 2023 17:34:07 +0200 Subject: [PATCH 5/8] docs: partial update CONTRIBUTING.md --- CONTRIBUTING.md | 109 ++++++++++++++++-------------------------------- 1 file changed, 37 insertions(+), 72 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc22293a..f485b3be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,66 +1,28 @@ # CASE Contribution -First off all, thanks you very much for contribute and Happy Hacktoberfest ! πŸŽ‰ +First off all, thanks you very much for contributing and Happy Hacktoberfest ! πŸŽ‰ -[CASE](https://case.app/) is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing on the data. +[CASE](https://case.app/) is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing only on the data. -The following is a set of guidelines for contributing to CASE and its packages, which are hosted in the [CASE Organization](https://github.com/casejs) on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request. +CASE is made with love, lo-fi and headaches using [Angular](https://github.com/angular/angular.js) and [Nest.js](https://github.com/nestjs/nest). #### Table Of Contents -[Code of Conduct](#code-of-conduct) - -[How Can I Contribute?](#how-can-i-contribute) - +- [Pre-requisites](#pre-requisites) +- [Making code contributions](#code-contributions) +- [Making pull Requests](#pull-requests) - [Reporting Bugs](#reporting-bugs) - [Suggesting Enhancements](#suggesting-enhancements) -- [Your First Code Contribution](#your-first-code-contribution) -- [Pull Requests](#pull-requests) - -[Serve CASE in contribution mode](#serve-case-in-contribution-mode) -[Publish your contribution](#publish-your-contribution) - -## Code of Conduct - -This project and everyone participating in it is governed by the [CASE Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@case.app](mailto:hello@case.app). - -## How Can I Contribute? - -### Reporting Bugs - -This section guides you through submitting a bug report for CASE. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:. - -When you are creating a bug report, please include as many details as possible. Fill out [the required template](.github/ISSUE_TEMPLATE/πŸ›-bug-report.md), the information it asks for helps us resolve issues faster. - -> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. - -### Suggesting Enhancements - -This section guides you through submitting an enhancement suggestion for CASE, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand and find your suggestion :pencil: :mag_right:. - -When you are creating an enhancement suggestion, please include as many details as possible. Start a new discussion by following [the template](.github/ISSUE_TEMPLATE/config.yml), including the steps that you imagine you would take if the feature you're requesting existed. - -### Your First Code Contribution - -Unsure where to begin contributing to CASE ? You can start by looking through these `good first issue` and `help wanted` issues: - -### Pull Requests +- [Serve CASE in contribution mode](#serve-case-in-contribution-mode) +- [Code of Conduct](#code-of-conduct) -The process described here has several goals: - -- Maintain CASE's quality -- Fix problems that are important to users -- Engage the community in working toward the best possible CASE -- Enable a sustainable system for CASE's maintainers to review contributions - -Please follow these steps to have your contribution considered by the maintainers: +### Pre-requisites -1. Follow all instructions in [the template](.github/pull_request_template.md) -2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing ?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+### Code contributions -While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. +If you are looking for an easy way to help you can start by the `good first issue` and `documentation` issues. -## Serve CASE in contribution mode +### Serve CASE in Contribution mode To run the client app on `http://localhost:4200`: @@ -84,33 +46,36 @@ You have to generate users credentials by seeding data to be able to auth with. The folder `packages/case/server/src/_contribution-root` replicates the app root folder of the `CASE Starter` repo. -Using `npm link` you can link your `/node_modules/@casejs/case` to the `dist` folder in your project made with CASE starter. +### Pull Requests -```bash -#From this repo CASE. -cd server/dist +The process described here has several goals: -# May require sudo. -npm link -``` +- Maintain CASE's quality +- Fix problems that are important to users +- Engage the community in working toward the best possible CASE +- Enable a sustainable system for CASE's maintainers to review contributions -Then go to your CASE starter project and run : +Please follow these steps to have your contribution considered by the maintainers: -```bash -#From your CASE starter project. -npm link @casejs/case -npm start -``` +1. Follow all instructions in [the template](.github/pull_request_template.md) +2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing ?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
+ +While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. -## Publish your contribution +### Reporting Bugs -Update the version number in `package.json` and run: +This section guides you through submitting a bug report for CASE. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:. -```bash -npm run build -cd server/dist -npm publish +When you are creating a bug report, please include as many details as possible. Fill out [the required template](.github/ISSUE_TEMPLATE/πŸ›-bug-report.md), the information it asks for helps us resolve issues faster. -# For beta versions -npm publish --tag beta -``` +> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. + +### Suggesting Enhancements + +This section guides you through submitting an enhancement suggestion for CASE, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand and find your suggestion :pencil: :mag_right:. + +When you are creating an enhancement suggestion, please include as many details as possible. Start a new discussion by following [the template](.github/ISSUE_TEMPLATE/config.yml), including the steps that you imagine you would take if the feature you're requesting existed. + +## Code of Conduct + +This project and everyone participating in it is governed by the [CASE Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@case.app](mailto:hello@case.app). From 8bef66fe2e57c972f48570fae0c6a3a363e0ff6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Tue, 26 Sep 2023 16:13:01 +0200 Subject: [PATCH 6/8] docs: update the CONTRIBUTING.md --- CONTRIBUTING.md | 62 ++++++++++++++++++++++++++++++++----------------- 1 file changed, 41 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f485b3be..6cc8cd69 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ # CASE Contribution -First off all, thanks you very much for contributing and Happy Hacktoberfest ! πŸŽ‰ +First off all, thanks you very much for contributing and Happy Hacktoberfest ! πŸŽ‰ πŸ§™β€β™‚οΈ [CASE](https://case.app/) is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing only on the data. -CASE is made with love, lo-fi and headaches using [Angular](https://github.com/angular/angular.js) and [Nest.js](https://github.com/nestjs/nest). +[CASE](https://case.app/) is made with love, lo-fi and headaches using [Angular](https://github.com/angular/angular.js), [Nest.js](https://github.com/nestjs/nest) & [TypeORM](https://github.com/typeorm/typeorm). #### Table Of Contents @@ -13,69 +13,89 @@ CASE is made with love, lo-fi and headaches using [Angular](https://github.com/a - [Making pull Requests](#pull-requests) - [Reporting Bugs](#reporting-bugs) - [Suggesting Enhancements](#suggesting-enhancements) -- [Serve CASE in contribution mode](#serve-case-in-contribution-mode) - [Code of Conduct](#code-of-conduct) ### Pre-requisites +Because [CASE](https://case.app/) is made with [Angular](https://github.com/angular/angular.js), the angular/cli is a pre-requisite. + +```bash +npm install -g @angular/cli +``` + +You may also meet the [TypeORM](https://github.com/typeorm/typeorm) syntax for concepts like entities, relations or repositories. You can familiarize yourself with [their docs here](https://typeorm.io/). + +Also [CASE](https://case.app/) use the concepts of guards, module and controller from [Nest.js](https://github.com/nestjs/nest). You can have a look to those concepts by checking [their docs here](https://docs.nestjs.com/). + +**_You don't need to be an expert in those dependencies to contribute, your great ideas, logic, good will & common sense are always welcome to the project ! 🧠🌈_** + ### Code contributions -If you are looking for an easy way to help you can start by the `good first issue` and `documentation` issues. +If you are looking for an easy way to help you can start by the issues labelled [good first issue](https://github.com/casejs/CASE/labels/good%20first%20issue) or [documentation](https://github.com/casejs/CASE/labels/documentation). πŸ’ͺ -### Serve CASE in Contribution mode +##### Serve CASE in Contribution mode -To run the client app on `http://localhost:4200`: +Open a first terminal : ```bash -#From root of the repo. +# From root of the repo. cd packages/case/client npm install ng serve --configuration=contribution ``` +The client is now running on `http://localhost:4200` ! 🌸 + +Open a second terminal simultaneously : + ```bash -# From packages/case/server -npm i +# From root of the repo. +cd packages/case/server +npm install npm run start:dev +# You have to generate users credentials by seeding data to be able to auth with. # Seed in dev mode npm run seed:dev ``` -You have to generate users credentials by seeding data to be able to auth with. +The server is now running on contributor mode ! 🌼 -The folder `packages/case/server/src/_contribution-root` replicates the app root folder of the `CASE Starter` repo. +> πŸ’‘ To simulate the `app` root folder of a new CASE repo, you can use the folder `packages/case/server/src/_contribution-root`. ### Pull Requests The process described here has several goals: -- Maintain CASE's quality +- Maintain our quality - Fix problems that are important to users -- Engage the community in working toward the best possible CASE -- Enable a sustainable system for CASE's maintainers to review contributions +- Engage the community in working toward the best possible version of [CASE](https://case.app/) +- Enable a sustainable system for our maintainers to review contributions -Please follow these steps to have your contribution considered by the maintainers: +Please follow these steps to have your contribution considered by our maintainers: 1. Follow all instructions in [the template](.github/pull_request_template.md) 2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing
What if the status checks are failing ?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.
While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted. +> πŸ§™β€β™‚οΈ During Hacktoberfest don't forget to add `hacktoberfest` label to your PR. If it's accepted we will merge it with the `hacktoberfest-accepted` label. +> If we judge it is, we will not hesitate to labelled your PR as `spammy` which can make you disqualified of the Hacktoberfest. 😱 + ### Reporting Bugs -This section guides you through submitting a bug report for CASE. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:. +When you are creating a bug report, please include as many details as possible. -When you are creating a bug report, please include as many details as possible. Fill out [the required template](.github/ISSUE_TEMPLATE/πŸ›-bug-report.md), the information it asks for helps us resolve issues faster. +Fill out [the required template](.github/ISSUE_TEMPLATE/πŸ›-bug-report.md), the information it asks for helps us resolve issues faster. -> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. +> πŸ’‘ If you find a **Closed** issue that seems to be the same bug that you're experiencing, open a new issue and include a link to the original issue in the body of your new one. ### Suggesting Enhancements -This section guides you through submitting an enhancement suggestion for CASE, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand and find your suggestion :pencil: :mag_right:. +When you are creating an enhancement suggestion, please include as many details as possible. -When you are creating an enhancement suggestion, please include as many details as possible. Start a new discussion by following [the template](.github/ISSUE_TEMPLATE/config.yml), including the steps that you imagine you would take if the feature you're requesting existed. +Start a new discussion by following [the template](.github/ISSUE_TEMPLATE/config.yml), including the steps that you imagine you would take if the feature you're requesting existed. ## Code of Conduct -This project and everyone participating in it is governed by the [CASE Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [hello@case.app](mailto:hello@case.app). +[CASE](https://case.app/) and everyone contributing in it is governed by the [CASE Code of Conduct](CODE_OF_CONDUCT.md). By contributing, you are expected to uphold this code. Please report unacceptable behavior to [hello@case.app](mailto:hello@case.app). From 745440af653396ed5db6d7bb3df81902935e417b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Tue, 26 Sep 2023 16:33:27 +0200 Subject: [PATCH 7/8] docs: add contributors images to the README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 47577282..55824ef3 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,13 @@ - [Discord](https://discord.gg/FepAked3W7) - Come chat with the CASE community - [Dev.to](https://dev.to/casejs) - Stay tuned to CASE developments - [Github](https://github.com/casejs/case/issues) - Report bugs and share ideas to improve the product. + +## Contributors + +Thanks to our first wonderful contributors ! + + + + + +Made with [contrib.rocks](https://contrib.rocks). From 6243c6828fc588e7056d788ee5e82c869f7cbf21 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Isma=C3=ABl=20Guerrib?= Date: Tue, 26 Sep 2023 16:49:58 +0200 Subject: [PATCH 8/8] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6cc8cd69..0946b479 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # CASE Contribution -First off all, thanks you very much for contributing and Happy Hacktoberfest ! πŸŽ‰ πŸ§™β€β™‚οΈ +Thanks you very much for contributing and Happy Hacktoberfest ! πŸŽ‰ πŸ§™β€β™‚οΈ [CASE](https://case.app/) is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing only on the data. @@ -17,21 +17,21 @@ First off all, thanks you very much for contributing and Happy Hacktoberfest ! ### Pre-requisites -Because [CASE](https://case.app/) is made with [Angular](https://github.com/angular/angular.js), the angular/cli is a pre-requisite. +[CASE](https://case.app/) is made with [Angular](https://github.com/angular/angular.js), the angular/cli is a pre-requisite. ```bash npm install -g @angular/cli ``` -You may also meet the [TypeORM](https://github.com/typeorm/typeorm) syntax for concepts like entities, relations or repositories. You can familiarize yourself with [their docs here](https://typeorm.io/). +You may also meet [TypeORM](https://github.com/typeorm/typeorm) concept's like entities, relations or repositories. You can familiarize yourself with [their docs here](https://typeorm.io/). -Also [CASE](https://case.app/) use the concepts of guards, module and controller from [Nest.js](https://github.com/nestjs/nest). You can have a look to those concepts by checking [their docs here](https://docs.nestjs.com/). +Also [CASE](https://case.app/) use the concepts of guards, module and controller from [Nest.js](https://github.com/nestjs/nest). You can have a better understanding of those concepts by checking [their docs here](https://docs.nestjs.com/). -**_You don't need to be an expert in those dependencies to contribute, your great ideas, logic, good will & common sense are always welcome to the project ! 🧠🌈_** +**_You don't need to be an expert in those dependencies to contribute - your great ideas, logic, good will & common sense are always welcome to the project ! 🧠🌈_** ### Code contributions -If you are looking for an easy way to help you can start by the issues labelled [good first issue](https://github.com/casejs/CASE/labels/good%20first%20issue) or [documentation](https://github.com/casejs/CASE/labels/documentation). πŸ’ͺ +If you are looking for an easy way to help, start by the issues labelled [good first issue](https://github.com/casejs/CASE/labels/good%20first%20issue) or [documentation](https://github.com/casejs/CASE/labels/documentation) ! πŸ’ͺ ##### Serve CASE in Contribution mode @@ -55,12 +55,14 @@ npm install npm run start:dev # You have to generate users credentials by seeding data to be able to auth with. -# Seed in dev mode +# Seed in dev mode. npm run seed:dev ``` The server is now running on contributor mode ! 🌼 +⚠️ Times to times you may need to restart your server to see the modifications you brings to the client. + > πŸ’‘ To simulate the `app` root folder of a new CASE repo, you can use the folder `packages/case/server/src/_contribution-root`. ### Pull Requests