Skip to content

Update README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 7, 2020
Merged

Update README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Please use your Demo Company organisation for your testing.
### Prerequirements
* python3.5+ installed
* git installed
* SSH keys setup for your github profile.

### Download the code
* Clone this repo to your local drive.
Expand All @@ -21,6 +22,22 @@ Please use your Demo Company organisation for your testing.
* Activate new virtual environment by running `source venv/bin/activate`
* Install project dependencies by running `pip install -r requirements.txt`

### Troubleshooting
If you see an error when installing the project dependencies that looks something like ...

```
Please make sure you have the correct access rights
and the repository exists.
fatal: clone of 'git@github.com:mitsuhiko/flask-sphinx-themes.git' into submodule path '/private/var/folders/7d/_bchn9r12pn79fr63p88nhv80000gn/T/pip-build-myovpzcq/Flask-Session/docs/_themes' failed
Failed to clone 'docs/_themes'. Retry scheduled
git@github.com: Permission denied (publickey).
```

Please check that your SSH keys are setup for your github profile?
https://github.com/settings/keys

We ran into some issues with the current version of Flask-Session and had to point to a specific commit and download that code into our project. But in order to do that your [SSH keys need to be config](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh).

## Create a Xero App
To obtain your API keys, follow these steps and create a Xero app

Expand Down