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

Formatting for API docs

Browse source
This commit is contained in:
Alicia Sykes 2024-03-12 11:55:09 +00:00
parent e33ee11595
commit 98b3f5803d
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
api/README.txt
View file

@ -1,5 +1,6 @@
AWESOME PRIVACY API SOURCE
============================================================================
AWESOME PRIVACY API SOURCE
============================================================================
ABOUT
@ -32,13 +33,13 @@ 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
3. Make any desired changes in `src/` - the server will auto reload
============================================================================
DEPLOYMENT
----------
1. Sign up for Cloudflare Workers (https://workers.dev) - free tier is fine
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