rohit-lakhanpal/azure-function-csharp

This project contains an Azure Function App written in C# with two functions: an HTTP trigger and a Queue trigger. It also includes infrastructure as code using Bicep and a CI/CD pipeline with GitHub Actions.

Azure Function App in C#

powered by

Table of Contents

1. About The Project
2. Technologies Explored
3. Getting Started
4. Deployment
5. Roadmap
6. Contributing
7. Disclaimer
8. License
9. Contact
10. Acknowledgments
11. References

About The Project

This project contains an Azure Function App written in C# with one function: an HTTP trigger. It also includes infrastructure as code using Bicep and a CI/CD pipeline with GitHub Actions.

(back to top)

Technologies Explored

Major cloud technologies/frameworks/libraries are listed here:

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

1. Pre-Requisites:

   Ensure you have the following installed if you choose to run the project locally:

   • 
   • 
   • 
   • 
   • 
   • 
   • 

2. Clone the Repository:

   git clone https://github.com/rohit-lakhanpal/azure-function-csharp.git
   
   cd azure-function-csharp

3. Start Azurite:
   Ensure you're running the Azurite emulator for local Azure Storage development. This will be used by the Azure Function App.

   My preference is to use the Visual Studio Code extension for Azurrite.

   Ctrl + Shift + P -> Azurite: Start
   

   Remember to stop and clear the Azurite data after you're done:

   Ctrl + Shift + P -> Azurite: Stop
   Ctrl + Shift + P -> Azurite: Clear Data
   

4. Start the Azure Function App:

   cd src/App
   func start

(back to top)

Deployment

For deploying the Azure Function App and its infrastructure, you can use the azd tool for a streamlined process.

1. Run the following command to deploy:

   azd login
   azd up

   This command will handle the deployment of both the infrastructure (using Bicep) and the function app.

(back to top)

Roadmap

• Add local debugging support
• Add devcontainer support
• Add more Azure Functions
• Improve error handling
• Add unit tests

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project: Fork the repo you want to contribute to by clicking the Fork button on the top right corner of the repo page.
2. Clone the Repo: Clone the forked repo to your local machine using the command (git clone URL_OF_FORK).
3. Branch: Create your Feature Branch (git checkout -b feature/AmazingFeature)
4. Commit: Commit your Changes (git commit -m 'Add some AmazingFeature')
5. Push to the Branch: (git push origin feature/AmazingFeature)
6. Open a Pull Request: Go to your forked repo on GitHub and click Contribute and then Open a pull request. Fill out the details of your pull request and submit it.

Learn more about contributing to projects here.

(back to top)

Disclaimer

This template is provided "as is" without warranty of any kind, whether express or implied. Use at your own risk! The author will not be liable for any losses or damages associated with the use of this template.

It is intended to be used as a starting point for your own project and not as a final product.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

• Rohit Lakhanpal | @github | rohit@try-it.dev
• Project Link: https://github.com/rohit-lakhanpal/azure-function-csharp

(back to top)

Acknowledgments

These toolkits are never the result of solitary efforts. I wish to extend my heartfelt thanks to my friends, colleagues, and fellow community members for their exceptional contributions. We have built upon your work, and it is your efforts that have laid the foundation for our success. Your work is not only recognised but deeply valued.

• This amazing ReadME template

TODO: Add acknowledgements.

(back to top)

References

• Azure Functions Documentation
• Bicep Documentation
• GitHub Actions Documentation

(back to top)

Documentation generated by AI, edited by humans. ❤️

(back to top)