Skip to content

Commit 000e277

Browse files
committed
some header cleanup
1 parent 0565409 commit 000e277

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@
55
- [Creating the marketplace app](#creating-the-marketplace-app)
66
- [Provider ID](#provider-id)
77
- [Authentication](#authentication)
8-
- [User Credentials](#user-credentials)
98
- [Provider Credentials](#provider-credentials)
109
- [Webstore Component Library](#webstore-component-library)
11-
- [Upgrading To The Latest Version](#upgrading-to-the-latest-version)
12-
- [Component Library Dev Mode](#component-library-dev-mode)
10+
- [Upgrading To The Latest Version](#upgrading-to-the-latest-version)
11+
- [Component Library Dev Mode](#component-library-dev-mode)
1312
- [Exception Handling](#exception-handling)
1413
- [Linting](#linting)
1514
- [Testing](#testing)
@@ -55,21 +54,21 @@ _The terms "client" and "provider" are fairly interchangeable in this applicatio
5554
| SENTRY_PROJECT | No | .env.development | The slug of the Sentry project associated with the Sentry application |
5655
| SENTRY_URL | No | .env.development | The base URL of the Sentry instance |
5756

58-
#### Creating the marketplace app
57+
### Creating the marketplace app
5958
Ensure that a marketplace, e.g. client-name.scientist.com, has been created by the Scientist.com Professional Services team. Once that exists, an application needs to be created on that marketplace by a developer with the proper permissions. This is how some of the environment variables are created. You'll know if you have the proper developer permissions if once logged in on the client marketplace, you can hover over your avatar and see "Applications" underneath the "Developer" settings. _If you don't have the permissions, you need to request them, or ask someone with the permissions to complete the steps below._
6059
- Once you've clicked the "Applications" link mentioned above, press "New Application"
6160
- Only the application name is required for the moment. Name it the same as the provider name.
6261
- Save, and you should be redirected to the "Developer Details" page
6362
- There will be a button that says "Reveal Token"
6463
- Click it. You'll need that token in the next step.
6564

66-
#### Provider ID
65+
### Provider ID
6766
In an API GUI (e.g. Postman) make a GET request for `<marketplace>/api/v2/providers.json?q=${PROVIDER_NAME}`. Your authorization will be your token from the step above, formatted as a Bearer Token. e.g. `Bearer MY_TOKEN` Scroll to the `provider_refs` array and use the `provider_id` value to fill in the `NEXT_PUBLIC_PROVIDER_ID` variable.
6867

69-
#### Authentication
68+
### Authentication
7069
All API endpoints in this app require some form of authentication. A logged out user will be able to access the home and browse pages using a provider credential, while a logged in user can access all pages using their own credentials.
7170

72-
##### Provider Credentials
71+
#### Provider Credentials
7372
Please run the following in your terminal:
7473
``` bash
7574
# When replacing the variables below with your actual values,
@@ -85,7 +84,7 @@ The curl command will return a JSON object that has an `access_token` property.
8584
## Webstore Component Library
8685
The webstore requires a [React component library](https://reactjs.org/docs/react-component.html) of view components. That dependency is packaged and released independently.
8786

88-
#### Upgrading To The Latest Version
87+
### Upgrading To The Latest Version
8988
In the terminal:
9089
``` bash
9190
# first check for whether there is an updated version
@@ -95,10 +94,10 @@ yarn outdated @scientist-softserv/webstore-component-library # check the values
9594
yarn upgrade @scientist-softserv/webstore-component-library --latest
9695
```
9796

98-
#### Component Library Dev Mode
97+
### Component Library Dev Mode
9998
Using the local github repository requires you to manually clone the component library to your computer, build, and link it:
10099

101-
##### Preparing your local copy of the component library:
100+
#### Preparing your local copy of the component library:
102101
_Prerequisite: clone the [webstore-component-library](https://github.com/scientist-softserv/webstore-component-library.git) and [get the app running](https://github.com/scientist-softserv/webstore-component-library#running-the-app)_
103102

104103
cd webstore-component-library
@@ -109,15 +108,15 @@ Choose one of the below:
109108
npm run build-lib # must be run every time you want a change to show in the webstore
110109
npm run watch-lib # run once and the wcl will watch for changes
111110

112-
##### Preparing your local copy of the webstore:
111+
#### Preparing your local copy of the webstore:
113112

114113
# run in a separate terminal window than where the wcl is
115114
cd webstore
116115
yarn link "@scientist-softserv/webstore-component-library"
117116
yarn remove @scientist-softserv/webstore-component-library
118117
(restart the dev server)
119118

120-
##### Return to using the packaged version of the webstore-component-library:
119+
#### Return to using the packaged version of the webstore-component-library:
121120
# in the webstore repository
122121
yarn unlink "@scientist-softserv/webstore-component-library"
123122
git checkout package.json yarn.lock
@@ -205,4 +204,4 @@ helm upgrade --install --kube-context=k3 --namespace=webstore-staging webstore-s
205204
``` -->
206205

207206
## Deployment
208-
We are currently using [Vercel](www.vercel.com) to auto deploy this app to our staging environment. The `main` branch is accessible at https://webstore-staging.vercel.app.
207+
Refer to the [Wiki](https://github.com/scientist-softserv/webstore/wiki/Deployment) for the most updated information.

0 commit comments

Comments
 (0)