👋 Welcome to PlatformPlatform

The ultimate open-source foundation designed for startups looking to create multi-tenant cloud SaaS services with ease, speed, scalability and enterprise grade security. Our platform showcases the best practices in building SaaS products, combining a cutting-edge technology stack, robust cloud architecture using Infrastructure as Code, full DevOps pipelines, and powerful tools to transform the way you develop and grow your software solutions. 🚀

Embrace the power of PlatformPlatform, built using .NET 7.0, C# 11.0, ASP.NET Minimal API, Entity Framework, Azure SQL, MediatR, and Fluent Validation. Elevate your frontend development with React, TypeScript, SCSS, and Jest. Leverage Azure Container Apps, Azure Service Bus, and other Azure PaaS services to create a seamless, reliable infrastructure. The platform is built showcasing Clean Architecture with Domain-Driven Design and CQRS at its core. 🏂

Please note that, as of now, PlatformPlatform is still in a very early stage. 🐣 You can follow our backlog and roadmap on the Projects tab.

🛠️ Setting up local debugging for Mac and Windows

Install SQL Server for local debugging

PlatformPlatform requires a SQL Server instance for debugging locally. You can use Azure SQL Edge in Docker Desktop on both Mac and Windows. On Windows you can also install SQL Server or SQL Server Express locally.

Running Azure SQL Edge in Docker Desktop

1. Install Docker Desktop if you haven't already.

2. Run the following command to pull the Azure SQL Edge image and start a container (use a password of your choice):

   docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=!MySecretPassword1" -p 1433:1433 --name sql_server -d mcr.microsoft.com/azure-sql-edge
   

3. Add the following line to your shell's configuration file:

   export SQL_DATABASE_PASSWORD='!MySecretPassword1'
   

• If you're using bash, edit the ~/.bashrc or ~/.bash_profile file.
• If you're using zsh, edit the ~/.zshrc file.

4. Restart the terminal and run echo $SQL_DATABASE_PASSWORD to verify that the environment variable is set correctly.

Windows: Installing SQL Server or SQL Server Express

1. Download and install SQL Server Developer Edition or SQL Server Express. Alternatively you can also use Docker Desktop.

2. During the installation, set the password for the sa user as !MySecretPassword1.

3. Set the enviroment varible in Windows (PowerShell) using this command:

   $Env:DB_PASSWORD="!MySecretPassword1"
   

Clone the repository

1. Open a terminal and navigate to the folder where you want to clone the repository.

2. Run the following command to clone the repository:

   git clone https://github.com/PlatformPlatform/platformplatform.git
   

Run and debug

1. Open a terminal and navigate to the root folder of the cloned PlatformPlatform repository.
2. Change directory to the account-management folder: cd account-management.
3. Run the following command to restore the dependencies and tools of the project: dotnet restore.
4. Run the following command to build and run the application: dotnet run --project AccountManagement.WebApi.
5. The application should now be running. You can access the API by navigating to https://localhost:5001 or http://localhost:5002.
6. To run tests, navigate to the test project folder (e.g., AccountManagement.Tests) and run the following command: dotnet test.
7. To debug the application, you can use an IDE like JetBrains Rider on both Windows and Mac or Visual Studio with ReSharper on Windows. Open the solution file (AccountManagement.sln) in your preferred IDE and start debugging using the built-in debugging tools.

You should now be able to run and debug your application locally on both Mac and Windows.

🤝 Code of Conduct

We are committed to fostering an open and welcoming environment for everyone involved in the project. Please read our Code of Conduct to understand our community guidelines and expectations.

🐞 Reporting Bugs and Feature Requests

If you encounter any bugs or have ideas for new features, we'd love to hear about them! To report a bug, please use this bug report template. For feature requests, please use our feature request template. This will help us keep track of issues and enhancements and respond to them efficiently.

💻 Contributing

We appreciate any contributions to the PlatformPlatform project! If you'd like to contribute, please read our Contributing Guidelines to understand the process and best practices for submitting your changes.

🔒 Security Policy

We take the security of our platform seriously. If you discover any security-related issues or vulnerabilities, please review and follow our Security Policy to report them responsibly. You can report security incidents using our GitHub Security Advisories page.

🔏 License

PlatformPlatform is released under the MIT License.