prehistoric-systems/awesome-privacy
1
0
Fork 0
mirror of https://github.com/Lissy93/awesome-privacy.git synced 2026-03-11 08:55:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Write API docs

Browse source
This commit is contained in:
Alicia Sykes 2024-03-09 15:26:08 +00:00
parent 38e5961dea
commit e1cdcb9518
2 changed files with 52 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
api/README.md
View file

@ -1,20 +0,0 @@
# Cloudflare Workers OpenAPI 3.1
This is a Cloudflare Worker with OpenAPI 3.1 using [itty-router-openapi](https://github.com/cloudflare/itty-router-openapi).
## Getting Started
1. You'll need Git and Node.js installed.
2. Then install [wrangler](https://developers.cloudflare.com/workers/cli-wrangler/install-update)
3. Clone this project, cd into it and install dependencies with `yarn install`
4. Run `yarn start` to start a local instance of the API.
## Development
1. Run `yarn dev` to start a local instance of the API.
2. Open `http://localhost:9000/` in your browser to see the Swagger interface where you can try the endpoints.
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.
## Deployment
1. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
2. Clone this project, cd into api and install dependencies with `yarn install`
3. Run `wrangler login` to login to your Cloudflare account in wrangler
4. Run `wrangler deploy` to publish the API to Cloudflare Workers

52
api/README.txt Normal file
View file

@ -0,0 +1,52 @@
AWESOME PRIVACY API SOURCE
============================================================================
ABOUT
-----
This directory contains the source for the Awesome Privacy API.
You can use the API to interact with our data programmatically.
The API is build using Hono, and intended for Cloudflare Workers.
============================================================================
PUBLIC INSTANCE
---------------
We have a free, no-auth, CORS-enabled instance which you can use.
Get started with the Swagger docs at https://api.awesomeprivacy.com
============================================================================
GETTING STARTED
---------------
1. You'll first need Git and Node.js installed on your system
2. Then install wrangler, `npm install wrangler --save-dev`
3. Download `git clone git@github.com:Lissy93/awesome-privacy.git`
4. And navigate int the api dir, with `cd awesome-privacy/api`
5. Install all required dependencies, by running `npm install`
4. Then run `yarn start` to start a local instance of the API
============================================================================
DEVELOPMENT
-----------
1. Run `yarn dev` to start a local instance of the API + Swagger interface
2. Open `http://localhost:9000` in your browser or with a HTTP client
3. Make any desired changes in `src/` - the server will automatically reload
============================================================================
DEPLOYMENT
----------
1. Sign up for Cloudflare Workers (https://workers.dev) - free tier is fine
2. Follow the steps in "Getting Started" to setup the project locally
3. Run `wrangler login` to login to your Cloudflare account in wrangler
4. Run `wrangler deploy` to publish the API to Cloudflare Workers
============================================================================
LICENSE
-------
This project is licensed under MIT, (C) Alicia Sykes <aliciasykes.com> 2024
See the GitHub repo for more info https://github.com/Lissy93/awesome-privacy