-
-
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.
chore: Update README with Angular Material badge
- Loading branch information
1 parent
1c47cfd
commit d7900ab
Showing
2 changed files
with
20 additions
and
26 deletions.
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 @@ | ||
github: [max-geller] |
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 |
---|---|---|
@@ -1,19 +1,26 @@ | ||
# Angular 18 Starter | ||
|
||
<h1 align="center"> | ||
Angular 18 SupaStarter :rocket: | ||
</h1> | ||
|
||
<p align="center"> | ||
![GitHub stars](https://img.shields.io/github/stars/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) | ||
|
||
</p> | ||
<p align="center"> | ||
![Angular](https://img.shields.io/badge/angular-%23DD0031.svg?style=for-the-badge&logo=angular&logoColor=white) | ||
![Supabase](https://img.shields.io/badge/Supabase-%233ECF8E.svg?style=for-the-badge&logo=supabase&logoColor=white) | ||
![Netlify](https://img.shields.io/badge/netlify-%23000000.svg?style=for-the-badge&logo=netlify&logoColor=#00C7B7) | ||
![Angular Material](https://img.shields.io/badge/Angular_Material-%23000000.svg?style=for-the-badge&logo=angular&logoColor=white) | ||
</p> | ||
|
||
<p align="center"> | ||
A production-ready starter template for building multi-tenant applications with Angular 18 and Supabase. | ||
</p> | ||
|
||
<p align="center"> | ||
![Demo GIF](path/to/demo.gif) | ||
|
||
</p> | ||
|
||
## Description | ||
|
||
|
@@ -23,11 +30,10 @@ This project is a multi-tenant starter SaaS application using Angular 18, Materi | |
|
||
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 | ||
|
||
- 🚀 Angular 18 | ||
- 🎨 Angular Material 18 | ||
- 🚀 Angular 18 | ||
- 🎨 Angular Material 18 | ||
- 🗄️ Supabase Integration | ||
- 👥 Multi-tenancy support | ||
- 🔐 Authentication and Authorization | ||
|
@@ -41,14 +47,7 @@ Angular provides a robust framework for building web applications, and Material | |
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). | ||
|
||
|
||
|
||
|
||
|
||
|
||
6. For detailed instructions, see our [Setup Guide](link-to-setup-guide). | ||
|
||
## Stack | ||
|
||
|
@@ -77,10 +76,9 @@ Use the following commands to deploy the application to Netlify: | |
This project uses a Postgres SQL database hosted on Supabase. | ||
## Environment Variables | ||
This project uses [ngx-env/builder](https://www.npmjs.com/package/@ngx-env/builder) to manage environment variables. | ||
This project uses [ngx-env/builder](https://www.npmjs.com/package/@ngx-env/builder) to manage environment variables. | ||
Be sure to create a '.env' file at the project root, which should be formatted in the following way: | ||
|
@@ -103,46 +101,41 @@ This project uses [Git](https://git-scm.com/) for source control. The following | |
## Multi-Tenancy | ||
This project uses a shared database and schema for all tenants. | ||
This project uses a shared database and schema for all tenants. | ||
### Tenant Configuration | ||
### User Management | ||
### 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)). | ||
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 [[email protected]](mailto:[email protected]). | ||
|
||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. | ||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |