Skip to content

Latest commit

 

History

History
47 lines (29 loc) · 1.93 KB

README.md

File metadata and controls

47 lines (29 loc) · 1.93 KB

contacts-manager

Cloudflare Worker to manage the contacts

This worker was bootstrapped using worker brick and configured with wrangler CLI. You can install it via NPM: npm install -g wrangler

Hooks

This repository is configured with client-side Git hooks that automatically format + lint the codebase before each push. You can install it by running the following command:

./hooks/INSTALL

Development

To properly run this service, you will need to a set up a .dev.vars file. Start by creating a copy of the .dev.vars.tpl file and fill the variables with values appropriate for the execution context.

Variable Name Variable Description
CONTACTS_DB_GITHUB_REPOSITORY_OWNER The owner/username of the repository that represents the contacts manager database.
CONTACTS_DB_GITHUB_REPOSITORY_REPO The identifier of the repository that represents the contacts manager database.
CONTACTS_DB_GITHUB_REPOSITORY_BRANCH The branch where the repository allows insert/update transactions.
CONTACTS_DB_GITHUB_REPOSITORY_TOKEN The personal access token (PAT) with read/write permission for the repository.

Run the local server via npm run start

Deploy

Setup worker environment variables with the following one-line:

IFS='='; ENV_FILE=.dev.vars; cat $ENV_FILE | while read line || [[ -n $line ]]; do read -ra envy <<< $line; wrangler secret put ${envy[0]} <<< ${envy[1]} ; done

Deploy to Cloudflare via npm run deploy

Contact

This template was prepared by:

  • João Freitas, @freitzzz
  • Rute Santos, @rutesantos4

Contact us if you need help on your project!