The API documentation for this project is located here. This remains up-to-date whenever this API project is updated.
To set this project up, you first need to pull from the shared package by getting a unique GitHub token then changing the .npmrc
file.
To get a token from GitHub that will allow you to run this project, do the following:
- Login to GitHub.
- Go to the personal access tokens page.
- Generate a new token.
- Check the
repo
andread:packages
boxes. - Copy the token.
Open a terminal and navigate to where you've downloaded MnemoSync API.
Now, type touch .env
in the main directory. Open the .env
file and add the following:
NPM_CONFIG_GITHUB_TOKEN=[YOUR GITHUB TOKEN]
Now you will be able to properly install all NPM dependencies.