Skip to content

Cookiecutter API templates for Azure Function Apps, AWS Lambdas, and Google Cloud Functions.

License

Notifications You must be signed in to change notification settings

Code-and-Sorts/cookiecutter-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

65f17ac Β· Dec 9, 2024

History

8 Commits
Aug 22, 2024
Dec 9, 2024
Dec 4, 2024
Dec 9, 2024
Dec 4, 2024
Dec 4, 2024
Nov 22, 2024
Aug 22, 2024
Aug 10, 2024
Dec 4, 2024
Dec 7, 2024

Repository files navigation

Cookiecutter API

This is a modern πŸͺ Cookiecutter template to create REST APIs for multiple cloud platforms in multiple languages. This template supports the multiple cloud platforms and languages.

πŸ§ͺ Usage

Install Cookiecutter using pip package manager:

# pipx is strongly recommended.
pipx install cookiecutter

# If pipx is not an option,
# you can install Cookiecutter in your Python user directory.
python -m pip install --user cookiecutter

To create a Cookiecutter API project, run the following for each implemented template.

# Create using the GH CLI
cookiecutter gh:Code-and-Sorts/cookiecutter-api/{LANGUAGE_OPTION}

# Create using the GH URL
cookiecutter https://github.com/Code-and-Sorts/cookiecutter-api.git --directory {LANGUAGE_OPTION}

Follow the prompts and answer them with your own desired options.

🌟 Supported Templates

Azure AWS GCP
Function App Lambda Cloud Function
βœ… πŸ“‹ πŸ“‹
βœ… πŸ“‹ πŸ“‹
βœ… πŸ“‹ πŸ“‹
πŸ“‹ πŸ“‹ πŸ“‹

Note

Each project follows the controller-service-repository pattern.

🎯 Examples

Python

Typescript

Dotnet

πŸ“š Resources

Below is a list of resources and documentation for the types of SDKs and frameworks used in the various Cookiecutter APIs.

Python

Typescript NodeJS

  • Yarn for dependency management
  • Jest for testing
  • Zod for schema validtion

Dotnet

Azure

AWS

Google Cloud

πŸ™πŸ» Acknowledgements

Florian Maas' cookiecutter-poetry repository was a very helpful resource for building out this Cookiecutter template.