# Introduction

To start using the Serverless API Gateway:

1. Clone the repository:

```
git clone https://github.com/irensaltali/serverlessapigateway.git
```

2. Install dependencies:

```
cd serverlessapigateway
npm install
```

3. Configure your routes, CORS settings, and JWT secrets within the provided configuration files.
4. Deploy your worker to Cloudflare using the command:

```
wrangler deploy
```

(For detailed setup and usage instructions, please see the Cloudflare Workers' [documentation](https://developers.cloudflare.com/workers)).

Usage Guidelines

* Ensure that each section of the JSON is correctly formatted according to the [schema](https://github.com/irensaltali/serverlessapigateway/blob/main/serverlessapigateway/src/api-config.schema.json).
* Modify the configuration to suit your application's requirements.
* The configuration should be loaded and parsed by your application at startup.
* Use canonical examples from [`serverlessapigateway/docs/config-examples`](https://github.com/irensaltali/serverlessapigateway/tree/main/serverlessapigateway/docs/config-examples) as the source of truth for docs and onboarding.

### Contributing

Your contributions are what make the Serverless API Gateway an even better API management solution! If you have suggestions for new features, notice a bug, or want to improve the code, please take the following steps:

1. Fork the repository.
2. Implement your changes on a new branch.
3. Submit a pull request with a clear description of your improvements.

### Acknowledgments

A shoutout to the contributors, community members, and the maintainers of Cloudflare Workers for their support and inspiration in making this project a reality.

The Serverless API Gateway is not just another API tool; it's created by developers, for developers, with the vision of making API management a breeze. Let's build together.

### Support

I'm always happy to help with any questions or concerns you may have. Feel free to reach out to me from on [Twitter](https://twitter.com/irensaltali) or [LinkedIn](https://www.linkedin.com/in/irensaltali/).

If you need a more extensive support you can always book on [Superpeer](https://superpeer.com/irensaltali/-/serverless-api-gateway)

### Companies that use Serverless API Gateway

[![](https://github.com/irensaltali/serverlessapigateway/raw/main/docs/img/wope.png)](https://wope.com/)

Let us know if you are using Serverless API Gateway and we can add your company here.\\