From 9c3a9e71471427584c50ed9f33781562a6031230 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 17:48:24 -0700 Subject: [PATCH 01/10] Updating contact information, migration information. --- CODE_OF_CONDUCT.md | 2 +- README.md | 3 +++ _guide/starting-new-supabase-project.md | 14 ++++++++++++++ 3 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 _guide/starting-new-supabase-project.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 2b81af1..4a60e64 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -26,7 +26,7 @@ Maintainers have the authority to remove, edit, or reject contributions (comment ## Enforcement -If you experience or witness any abusive or unacceptable behavior, please report it to the project lead. We’ll review and investigate all complaints, and respond in a way that fits the situation. We’ll also make sure to keep the reporter’s information confidential. +If you experience or witness any abusive or unacceptable behavior, please report it to the [project owner](mailto:angular.supastarter@gmail.com). We’ll review and investigate all complaints, and respond in a way that fits the situation. We’ll also make sure to keep the reporter’s information confidential. If a project maintainer doesn't enforce the Code of Conduct in good faith, they may face temporary or permanent consequences as decided by other leaders in the project. diff --git a/README.md b/README.md index 6790dc5..111aa9d 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,6 @@ This project uses a shared database and schema for all tenants. ### Roles and Permissions +## Contact + +If you have any questions, please contact the project owner at [angular.supastarter@gmail.com](mailto:angular.supastarter@gmail.com). diff --git a/_guide/starting-new-supabase-project.md b/_guide/starting-new-supabase-project.md new file mode 100644 index 0000000..c532f7a --- /dev/null +++ b/_guide/starting-new-supabase-project.md @@ -0,0 +1,14 @@ +To recreate the development supbase project with the same tables and data, follow these steps: + +Dump the schema and data from your development database: + +```bash +pg_dump -h db.xxxxxxxxxxxx.supabase.co -U postgres -d postgres > backup.sql +``` + + +Restore the dump to your production database: + +```bash +psql -h db.yyyyyyyyyyyy.supabase.co -U postgres -d postgres < backup.sql +``` From d9e0030a909ca3733fb6a17b5d5c39ce8bc2fac6 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 17:55:36 -0700 Subject: [PATCH 02/10] updating instruction for new sql project migrations --- _guide/starting-new-supabase-project.md | 110 ++++++++++++++++++++++++ 1 file changed, 110 insertions(+) diff --git a/_guide/starting-new-supabase-project.md b/_guide/starting-new-supabase-project.md index c532f7a..60ce988 100644 --- a/_guide/starting-new-supabase-project.md +++ b/_guide/starting-new-supabase-project.md @@ -12,3 +12,113 @@ Restore the dump to your production database: ```bash psql -h db.yyyyyyyyyyyy.supabase.co -U postgres -d postgres < backup.sql ``` + + +Your idea for creating a starter template for a multi-tenant Angular 18 application with Supabase integration is excellent. Database migrations are indeed a powerful tool that can help achieve what you're aiming for. Let's dive deeper into database migrations and how they can be used in your scenario. +Database Migrations Explained: +Database migrations are a way to manage changes to your database schema over time. They allow you to version control your database structure, making it easier to collaborate with team members and deploy changes across different environments. +The commands you mentioned: +1. supabase migration new create_users_table: +This command creates a new migration file. It doesn't actually create the table; it just generates a timestamped SQL file where you can write the SQL commands to create your table. +2. supabase migration up: +This command applies all pending migrations to your database. It runs the SQL in your migration files in order. +Migrating Multiple Tables: +Yes, you can absolutely migrate multiple tables. You can create separate migration files for each table or include multiple table creations in a single migration file. +Sharing Migrations: +Migrations can be easily shared as they are just SQL files. You can include these files in your repository, allowing others to apply the same database structure to their own Supabase projects. +Making It Easy for Users: +You can indeed create a streamlined process for users to set up their own instance of your starter template. Here's a potential workflow: + + +1. User clones your repository +2. User creates a new Supabase project +3. User updates the .env file with their Supabase URL and API key +4. User runs a script that applies all migrations + +Here's how you could implement this: + +1. Create a migrations folder in your project: + +```bash +project-root/ + ├── migrations/ + │ ├── 20230601000000_create_users_table.sql + │ ├── 20230601000001_create_tenants_table.sql + │ └── 20230601000002_create_products_table.sql + ├── scripts/ + │ └── apply-migrations.js + └── .env +``` + +2. In each migration file, include the SQL to create your tables: +```sql +CREATE TABLE users ( + id UUID DEFAULT uuid_generate_v4() PRIMARY KEY, + email TEXT UNIQUE NOT NULL, + encrypted_password TEXT NOT NULL, + created_at TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP +); + +-- Add any necessary indexes or constraints +CREATE INDEX users_email_idx ON users (email); +``` + +3. Create a Node.js script to apply migrations: + +```js +const { createClient } = require('@supabase/supabase-js'); +const fs = require('fs').promises; +const path = require('path'); + +require('dotenv').config(); + +const supabase = createClient(process.env.SUPABASE_URL, process.env.SUPABASE_KEY); + +async function applyMigrations() { + const migrationFiles = await fs.readdir(path.join(__dirname, '../migrations')); + + for (const file of migrationFiles.sort()) { + console.log(`Applying migration: ${file}`); + const sql = await fs.readFile(path.join(__dirname, '../migrations', file), 'utf8'); + const { error } = await supabase.rpc('exec', { sql }); + if (error) throw error; + } + + console.log('All migrations applied successfully'); +} + +applyMigrations().catch(console.error); + +``` + + +4. Add a script to your package.json: + +```json +{ + "scripts": { + "apply-migrations": "node scripts/apply-migrations.js" + } +} +``` + +5. In your README, provide clear instructions: + +```markdown +# Multi-Tenant Angular 18 Starter Template + +## Setup + +1. Clone this repository +2. Create a new Supabase project at https://supabase.com +3. Copy `.env.example` to `.env` and fill in your Supabase URL and API key +4. Run `npm install` +5. Run `npm run apply-migrations` to set up your database schema +6. Start your Angular app with `ng serve` +``` + + +This approach makes it very easy for users to set up their own instance of your starter template. They just need to follow a few simple steps, and the migration script will handle setting up all the necessary tables in their Supabase project. +Remember to include appropriate error handling and possibly a way to roll back migrations if something goes wrong. Also, consider adding seed data if your starter template requires some initial data to function properly. +This setup provides a good balance between flexibility (users can modify migrations if needed) and ease of use (a single command sets up the database). It's a common pattern used in many web application frameworks and should be familiar to many developers. + From 54ce1cffa07dcc0120cbb3a4b3faf8aae5a49d27 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 18:00:41 -0700 Subject: [PATCH 03/10] Adding engagement ideas --- README.md | 49 ++++++++++++++++++++++++++++++++++++++ _guide/engagement-ideas.md | 42 ++++++++++++++++++++++++++++++++ 2 files changed, 91 insertions(+) create mode 100644 _guide/engagement-ideas.md diff --git a/README.md b/README.md index 111aa9d..e517ea9 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,53 @@ # Angular 18 Starter + +![GitHub stars](https://img.shields.io/github/stars/yourusername/your-repo-name?style=social) +![GitHub forks](https://img.shields.io/github/forks/yourusername/your-repo-name?style=social) +![GitHub issues](https://img.shields.io/github/issues/yourusername/your-repo-name) +![GitHub license](https://img.shields.io/github/license/yourusername/your-repo-name) + +A production-ready starter template for building multi-tenant applications with Angular 18 and Supabase. + +![Demo GIF](path/to/demo.gif) + ## Description This project is a multi-tenant starter SaaS application using Angular 18, Material Design. This project is configured to be hosted on Netlify and uses Supabase as the database and authentication provider. + +## Features + +- 🚀 Angular 18 +- 🎨 Angular Material 18 +- 🗄️ Supabase Integration +- 👥 Multi-tenancy support +- 🔐 Authentication and Authorization +- 🎨 Customizable theming +- 📱 Responsive design + +## Quick Start + +1. Clone the repository +2. Set up your Supabase project +3. Configure environment variables +4. Run database migrations +5. Start the development server +6. +For detailed instructions, see our [Setup Guide](link-to-setup-guide). + + +## Contributing + +We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. + + +## Support + +If you like this project, please give it a ⭐️ on GitHub! + + + + ## Stack | Name | Description | Version | @@ -71,3 +115,8 @@ This project uses a shared database and schema for all tenants. ## Contact If you have any questions, please contact the project owner at [angular.supastarter@gmail.com](mailto:angular.supastarter@gmail.com). + + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. \ No newline at end of file diff --git a/_guide/engagement-ideas.md b/_guide/engagement-ideas.md new file mode 100644 index 0000000..e2980c7 --- /dev/null +++ b/_guide/engagement-ideas.md @@ -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. \ No newline at end of file From 25edc72ac3478df81bdffdb953084140cdf3e684 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 18:21:08 -0700 Subject: [PATCH 04/10] updating readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index e517ea9..d2673a9 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,20 @@ For detailed instructions, see our [Setup Guide](link-to-setup-guide). We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. +We use GitHub Projects to organize our work. Here's how you can get involved: + +1. Check our [Project Board](link-to-your-project-board). +2. Look for issues labeled "good first issue" or "help wanted". +3. Comment on an issue you'd like to work on. +4. Fork the repository and create a branch for your work. +5. Submit a pull request when you're ready for review. + +Our project board columns: +- **To Do**: Approved tasks that are ready to be worked on. +- **In Progress**: Tasks currently being worked on. Please assign yourself. +- **Review**: Pull requests and tasks ready for review. +- **Done**: Completed and merged tasks. + ## Support From 47bb8a7b7ba28dce54b615f550216ca068ba4798 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:22:36 -0700 Subject: [PATCH 05/10] adding purpose section to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index d2673a9..45f7ca6 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ A production-ready starter template for building multi-tenant applications with This project is a multi-tenant starter SaaS application using Angular 18, Material Design. This project is configured to be hosted on Netlify and uses Supabase as the database and authentication provider. +## Purpose + +Angular provides a robust framework for building web applications, and Material Design provides a modern and responsive UI component library. This project aims to provide a starting point for building a multi-tenant application with Angular and Supabase by implementing a number of features that are commonly needed in such applications.This project is designed to be a starting point for building a multi-tenant Angular application with Angular and Supabase using the latest technologies and best practices. + ## Features From ffa3705ba7a574c4527c34e71ebf98b0f955c0f8 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:23:42 -0700 Subject: [PATCH 06/10] updating readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 45f7ca6..fc9acd5 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Angular 18 Starter -![GitHub stars](https://img.shields.io/github/stars/yourusername/your-repo-name?style=social) -![GitHub forks](https://img.shields.io/github/forks/yourusername/your-repo-name?style=social) -![GitHub issues](https://img.shields.io/github/issues/yourusername/your-repo-name) -![GitHub license](https://img.shields.io/github/license/yourusername/your-repo-name) +![GitHub stars](https://img.shields.io/github/stars/max-geller/angular-supastarter?style=social) +![GitHub forks](https://img.shields.io/github/forks/max-geller/angular-supastarter/?style=social) +![GitHub issues](https://img.shields.io/github/issues/max-geller/angular-supastarter) +![GitHub license](https://img.shields.io/github/license/max-geller/angular-supastarter) A production-ready starter template for building multi-tenant applications with Angular 18 and Supabase. From 1ec2153c73d0d0555f149afc984d9645d0d264ba Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:33:57 -0700 Subject: [PATCH 07/10] adding contributing page --- CONTRIBUTING.md | 165 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 46 +++++++------- 2 files changed, 189 insertions(+), 22 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4f2bdf3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,165 @@ +# 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) + - [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) + +## 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! \ No newline at end of file diff --git a/README.md b/README.md index fc9acd5..ca44a20 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ ![GitHub stars](https://img.shields.io/github/stars/max-geller/angular-supastarter?style=social) -![GitHub forks](https://img.shields.io/github/forks/max-geller/angular-supastarter/?style=social) ![GitHub issues](https://img.shields.io/github/issues/max-geller/angular-supastarter) ![GitHub license](https://img.shields.io/github/license/max-geller/angular-supastarter) @@ -40,29 +39,8 @@ Angular provides a robust framework for building web applications, and Material For detailed instructions, see our [Setup Guide](link-to-setup-guide). -## Contributing - -We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. - -We use GitHub Projects to organize our work. Here's how you can get involved: - -1. Check our [Project Board](link-to-your-project-board). -2. Look for issues labeled "good first issue" or "help wanted". -3. Comment on an issue you'd like to work on. -4. Fork the repository and create a branch for your work. -5. Submit a pull request when you're ready for review. - -Our project board columns: -- **To Do**: Approved tasks that are ready to be worked on. -- **In Progress**: Tasks currently being worked on. Please assign yourself. -- **Review**: Pull requests and tasks ready for review. -- **Done**: Completed and merged tasks. -## Support - -If you like this project, please give it a ⭐️ on GitHub! - @@ -130,6 +108,30 @@ This project uses a shared database and schema for all tenants. ### Roles and Permissions +## Contributing + +We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details. + +We use GitHub Projects to organize our work. Here's how you can get involved: + +1. Check our [Project Board]((https://github.com/users/max-geller/projects/40/views/1)). +2. Look for issues labeled "good first issue" or "help wanted". +3. Comment on an issue you'd like to work on. +4. Fork the repository and create a branch for your work. +5. Submit a pull request when you're ready for review. + +Our project board columns: +- **To Do**: Approved tasks that are ready to be worked on. +- **In Progress**: Tasks currently being worked on. Please assign yourself. +- **Review**: Pull requests and tasks ready for review. +- **Done**: Completed and merged tasks. + + +## Support + +If you like this project, please give it a ⭐️ on GitHub! + + ## Contact If you have any questions, please contact the project owner at [angular.supastarter@gmail.com](mailto:angular.supastarter@gmail.com). From 7a536427dd618c47fbe8c403266d3145aa0f5980 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:50:13 -0700 Subject: [PATCH 08/10] updating readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ca44a20..3bb765c 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ A production-ready starter template for building multi-tenant applications with ![Demo GIF](path/to/demo.gif) + ## Description This project is a multi-tenant starter SaaS application using Angular 18, Material Design. This project is configured to be hosted on Netlify and uses Supabase as the database and authentication provider. From fd33c70f0f638ab46f79f5830f7d19ef0828d45a Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:50:21 -0700 Subject: [PATCH 09/10] adding github deploy yaml for production --- .github/workflows/main.yaml | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/workflows/main.yaml diff --git a/.github/workflows/main.yaml b/.github/workflows/main.yaml new file mode 100644 index 0000000..28c7c68 --- /dev/null +++ b/.github/workflows/main.yaml @@ -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 }} From 7e25fbda378013db5248ce94a9da05f85766f9e0 Mon Sep 17 00:00:00 2001 From: Max Geller Date: Fri, 4 Oct 2024 19:56:26 -0700 Subject: [PATCH 10/10] Drafting priorities section to contributing.md --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f2bdf3..13debf6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,6 +6,7 @@ First off, thank you for considering contributing to this project! It's people l - [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) @@ -25,6 +26,17 @@ First off, thank you for considering contributing to this project! It's people l - [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].