genericsuite-be-scripts/README.md

GenericSuite Scripts (backend version)

# The GenericSuite Scripts (backend version).

<img 
    align="right"
    width="100"
    height="100"
    src="https://genericsuite.carlosjramirez.com/images/gs_logo_circle.svg"
    title="GenericSuite logo by Carlos J. Ramirez"
/>

[GenericSuite](https://www.carlosjramirez.com/genericsuite/) is a versatile backend solution, designed to provide a comprehensive suite of features for Python APIs. It supports various frameworks including Chalice, FastAPI, and Flask, making it adaptable to a range of projects.<be/>
This repository contains the backend scripts necessary to build and deploy APIs made by the backend version of [The GenericSuite](https://www.carlosjramirez.com/genericsuite/).

## Features

- **AWS Deployment**: Deployment to AWS as Lambda Function with API Gateway usig SAM (AWS Serverless Application Model).
- **Local Development Environment**: running with http or https, with or without Docker.
- **Local DNS Server**: to allow https API access with a domain name like `app.exampleapp.local` and allow access from another devices locally (e.g. smartphones) to test your App.
- **Self-signed SSL certificates creation**: to allow local development frontend and backend environments run over secure https connections.
- **Common JSON config management**: to add the Git Submodule with the common JSON config directories.
- **Local MongoDB Docker conntainer**: used by the test site and allows to have an offline local development environment.



## Getting Started

Visit the [GenericSuite Documentation](https://genericsuite.carlosjramirez.com/Backend-Development/GenericSuite-Scripts/) for details about getting started, pre-requisites, installation, configuration, structure and operation.

## Usage

Check the [The GenericSuite backend development scripts](https://genericsuite.carlosjramirez.com/Backend-Development/GenericSuite-Scripts#usage) for more details.

## Documentation

* [https://genericsuite.carlosjramirez.com](https://genericsuite.carlosjramirez.com)
* Mirror: [https://genericsuite.readthedocs.io](https://genericsuite.readthedocs.io)

## License

GenericSuite is open-sourced software licensed under the [ISC license](./LICENSE).

## Credits

This project is developed and maintained by [Carlos J. Ramirez](https://github.com/tomkat-cr). For more information or to contribute to the project, visit [The GenericSuite Scripts (backend version) on GitHub](https://github.com/tomkat-cr/genericsuite-be-scripts).

Happy Coding!