-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'development' into staging
- Loading branch information
Showing
6 changed files
with
445 additions
and
1 deletion.
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,28 @@ | ||
| name: Production Build and Deploy | ||
| on: | ||
| push: | ||
| branches: | ||
| - main | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Set up Node.js | ||
| uses: actions/setup-node@v3 | ||
| with: | ||
| node-version: 20 | ||
|
|
||
| - name: Build Angular app to prod | ||
| working-directory: angular-starter | ||
| run: npm install && npm run build --configuration=production | ||
|
|
||
| - name: Deploy to GitHub Pages (Production) | ||
| uses: JamesIves/github-pages-deploy-action@v4 | ||
| with: | ||
| folder: angular-starter/dist/browser | ||
| branch: prod | ||
| token: ${{ secrets.GH_TOKEN }} |
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
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,177 @@ | ||
| # Contributing to Multi-Tenant Angular 18 Starter with Supabase | ||
|
|
||
| First off, thank you for considering contributing to this project! It's people like you that make this starter template a great tool for the Angular developercommunity. | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [Contributing to Multi-Tenant Angular 18 Starter with Supabase](#contributing-to-multi-tenant-angular-18-starter-with-supabase) | ||
| - [Table of Contents](#table-of-contents) | ||
| - [Priorities](#priorities) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [I Have a Question](#i-have-a-question) | ||
| - [I Want To Contribute](#i-want-to-contribute) | ||
| - [Reporting Bugs](#reporting-bugs) | ||
| - [Before Submitting a Bug Report](#before-submitting-a-bug-report) | ||
| - [How Do I Submit a Good Bug Report?](#how-do-i-submit-a-good-bug-report) | ||
| - [Suggesting Enhancements](#suggesting-enhancements) | ||
| - [Before Submitting an Enhancement](#before-submitting-an-enhancement) | ||
| - [How Do I Submit a Good Enhancement Suggestion?](#how-do-i-submit-a-good-enhancement-suggestion) | ||
| - [Your First Code Contribution](#your-first-code-contribution) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Setup](#setup) | ||
| - [Improving The Documentation](#improving-the-documentation) | ||
| - [Styleguides](#styleguides) | ||
| - [Commit Messages](#commit-messages) | ||
| - [TypeScript Styleguide](#typescript-styleguide) | ||
| - [Documentation Styleguide](#documentation-styleguide) | ||
| - [Join The Project Team](#join-the-project-team) | ||
|
|
||
| ## Priorities | ||
|
|
||
| - Security | ||
| - Performance | ||
| - Bug Fixes | ||
| - New Features | ||
| - Documentation | ||
| - Examples | ||
|
|
||
|
|
||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [your-email@example.com]. | ||
|
|
||
| ## I Have a Question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/max-geller/angular-supastarter/wiki). | ||
| Before you ask a question, it is best to search for existing [Issues](https://github.com/max-geller/angular-supastarter/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first. | ||
|
|
||
| If you then still feel the need to ask a question and need clarification, we recommend the following: | ||
|
|
||
| - Open an [Issue](https://github.com/max-geller/angular-supastarter/issues/new). | ||
| - Provide as much context as you can about what you're running into. | ||
| - Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. | ||
|
|
||
| We will then take care of the issue as soon as possible. | ||
|
|
||
| ## I Want To Contribute | ||
|
|
||
| > ### Legal Notice | ||
| > When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license. | ||
| ### Reporting Bugs | ||
|
|
||
| #### Before Submitting a Bug Report | ||
|
|
||
| A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible. | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/max-geller/angular-supastarter/wiki). If you are looking for support, you might want to check [this section](#i-have-a-question)). | ||
| - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/max-geller/angular-supastarter/issues?q=label%3Abug). | ||
| - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. | ||
| - Collect information about the bug: | ||
| - Stack trace (Traceback) | ||
| - OS, Platform and Version (Windows, Linux, macOS, x86, ARM) | ||
| - Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant. | ||
| - Possibly your input and the output | ||
| - Can you reliably reproduce the issue? And can you also reproduce it with older versions? | ||
|
|
||
| #### How Do I Submit a Good Bug Report? | ||
|
|
||
| > You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to [your-email@example.com]. | ||
| We use GitHub issues to track bugs and errors. If you run into an issue with the project: | ||
|
|
||
| - Open an [Issue](https://github.com/max-geller/angular-supastarter/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) | ||
| - Explain the behavior you would expect and the actual behavior. | ||
| - Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. | ||
| - Provide the information you collected in the previous section. | ||
|
|
||
| Once it's filed: | ||
|
|
||
| - The project team will label the issue accordingly. | ||
| - A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced. | ||
| - If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution). | ||
|
|
||
| ### Suggesting Enhancements | ||
|
|
||
| This section guides you through submitting an enhancement suggestion for Multi-Tenant Angular 18 Starter with Supabase, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. | ||
|
|
||
| #### Before Submitting an Enhancement | ||
|
|
||
| - Make sure that you are using the latest version. | ||
| - Read the [documentation](https://github.com/max-geller/angular-supastarter/wiki) carefully and find out if the functionality is already covered, maybe by an individual configuration. | ||
| - Perform a [search](https://github.com/max-geller/angular-supastarter/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. | ||
| - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. | ||
|
|
||
| #### How Do I Submit a Good Enhancement Suggestion? | ||
|
|
||
| Enhancement suggestions are tracked as [GitHub issues](https://github.com/max-geller/angular-supastarter/issues). | ||
|
|
||
| - Use a **clear and descriptive title** for the issue to identify the suggestion. | ||
| - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. | ||
| - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. | ||
| - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. | ||
| - **Explain why this enhancement would be useful** to most Multi-Tenant Angular 18 Starter with Supabase users. You may also want to point out the other projects that solved it better and which could serve as inspiration. | ||
|
|
||
| ### Your First Code Contribution | ||
|
|
||
| #### Prerequisites | ||
|
|
||
| - Familiarity with Git and GitHub | ||
| - Node.js and npm installed on your local machine | ||
| - Basic understanding of Angular and Supabase | ||
|
|
||
| #### Setup | ||
|
|
||
| 1. Fork the repository on GitHub | ||
| 2. Clone your fork locally | ||
| 3. Create a new branch for your contribution | ||
| 4. Install dependencies with `npm install` | ||
| 5. Make your changes | ||
| 6. Test your changes | ||
| 7. Commit your changes | ||
| 8. Push to your fork | ||
| 9. Submit a Pull Request | ||
|
|
||
| For more detailed instructions, please refer to our [Development Setup Guide](https://github.com/max-geller/angular-supastarter/wiki/) in the wiki. | ||
|
|
||
| ### Improving The Documentation | ||
|
|
||
| Documentation is crucial for this project. If you find any gaps in the documentation, unclear explanations, or areas that can be improved, please submit a Pull Request with your suggested changes. | ||
|
|
||
| ## Styleguides | ||
|
|
||
| ### Commit Messages | ||
|
|
||
| - Use the present tense ("Add feature" not "Added feature") | ||
| - Use the imperative mood ("Move cursor to..." not "Moves cursor to...") | ||
| - Limit the first line to 72 characters or less | ||
| - Reference issues and pull requests liberally after the first line | ||
|
|
||
| ### TypeScript Styleguide | ||
|
|
||
| All TypeScript code is linted with [ESLint](https://eslint.org/). Please run `npm run lint` before committing to ensure your code meets our styling requirements. | ||
|
|
||
| - 2 spaces for indentation | ||
| - Prefer `const` over `let` | ||
| - Use meaningful variable names | ||
| - Use PascalCase for class names and camelCase for function and variable names | ||
|
|
||
| ### Documentation Styleguide | ||
|
|
||
| - Use [Markdown](https://guides.github.com/features/mastering-markdown/) for documentation | ||
| - Reference functions and classes in backticks: \`functionName()\` | ||
| - Use code blocks for examples: | ||
| ```typescript | ||
| function example() { | ||
| console.log('This is an example'); | ||
| } | ||
| ``` | ||
|
|
||
| ## Join The Project Team | ||
|
|
||
| If you're interested in becoming a maintainer, please send an email to [angular.supastarter@gmail.com]. We're always looking for enthusiastic contributors who can help drive this project forward! | ||
|
|
||
| Thank you for your interest in contributing to Multi-Tenant Angular 18 Starter with Supabase. We look forward to your contributions! |
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
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,42 @@ | ||
| Optimize your GitHub repository: | ||
| a) Choose a clear, descriptive name for your repository. | ||
| b) Write a concise, informative description. | ||
| c) Add relevant topics/tags to your repository (e.g., "angular", "supabase", "multi-tenant", "starter-template"). | ||
| d) Create a detailed README.md file. | ||
| Create a high-quality README: | ||
| a) Clearly explain the purpose and features of your starter template. | ||
| b) Provide clear setup instructions. | ||
| c) Include screenshots or GIFs demonstrating the application. | ||
| d) List the technologies used. | ||
| e) Explain how to contribute. | ||
| Add a CONTRIBUTING.md file: | ||
| Outline how others can contribute to your project, including: | ||
| a) How to report issues | ||
| b) How to suggest enhancements | ||
| c) Coding standards | ||
| d) Pull request process | ||
| Use GitHub features: | ||
| a) Create and use Projects boards to track tasks. | ||
| b) Use Issues to track bugs and feature requests. | ||
| c) Add a license (e.g., MIT License) to clarify how others can use your code. | ||
| Promote your project: | ||
| a) Share on social media platforms (Twitter, LinkedIn, dev.to, etc.). | ||
| b) Post on relevant subreddits (r/angular, r/webdev, etc.). | ||
| c) Write blog posts or articles about your project and its features. | ||
| d) Present at local meetups or conferences. | ||
| Engage with the community: | ||
| a) Respond promptly to issues and pull requests. | ||
| b) Thank contributors for their work. | ||
| c) Participate in discussions about your project. | ||
| 7. Use GitHub Actions: | ||
| Set up CI/CD pipelines to automatically run tests and deployments, showing that your project is actively maintained. | ||
| Create good first issues: | ||
| Label some simple tasks as "good first issue" to encourage new contributors. | ||
| 9. Keep it updated: | ||
| Regularly update your dependencies and Angular version to show the project is actively maintained. | ||
| 10. Collaborate with others: | ||
| Reach out to other developers or projects in the Angular and Supabase ecosystems for potential collaborations. | ||
| 11. Use badges: | ||
| Add badges to your README (e.g., build status, version, license) to provide quick information about your project. | ||
| 12. Create documentation: | ||
| Consider creating more detailed documentation using tools like GitBook or GitHub Pages. |
Oops, something went wrong.