@mytmpvpn/mytmpvpn-client

mytmpvpn-client

Client-side library for the MyTmpVpn project.

Getting started

Follow instructions from mytmpvpn-cli

Testing

Setting up the test users

You need to export the following environment variables:

export TEST_USERNAME_TEMPLATE='ic-test-<UUID>-${id}@mytmpvpn.awsapps.com'

where <UUID> relates to those entries in your backend configuration file:

autoConfirmUserList: [
                'ic-test-<UUID>-[0-9a-f][e-mail]'
            ],
defaultPeanutsMap: {
                'ic-test-<UUID>-[0-9a-f][e-mail]': 10
            },

Here is an example:

export TEST_USERNAME_TEMPLATE='ic-test-863ed4f0-208f-442d-9684-3c33d664ea41-${id}@mytmpvpn.awsapps.com'

Note that ${id} MUST NOT be replaced here as it should be part of the string.

Setting up the mytmpvpn application configuration file

You also need to define the MYTMPVPN_APPCONFIG_FILE environment variable that points to your own backend, e.g:

export MYTMPVPN_APPCONFIG_FILE=~/.config/mytmpvpn/mytmpvpn-appconfig-dev.json

This file should contains entries like:

$ cat $MYTMPVPN_APPCONFIG_FILE 
{
    "apiUrl": "https://<some_stuff>.amazonaws.com/prod/",
    "userPoolClientId": "<your_user_pool_client_id>",
    "version": "v1",
    "userPoolId": "<your_user_pool_id>"
}

Those entries are provided by your backend. For example running cdk deploy --all or cdk watch --all should output those entries.

Running the test

Then you just need:

npm test

TODO: write down remaining sections

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.