Skip to content
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

update readme file #188

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

update readme file #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48f7395
update readme file
voytek98 May 31, 2023
5c40a3e
remove visable borders from images
voytek98 May 31, 2023
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
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ The Tech Radar is a list of technologies along with their assessment result pres
- Filtering by adoption levels and teams who use specific technologies/tools
- Details view with logo, description, alternatives and links
- Mobile support
- Skills Matrix for filling skills by users

## Skills Matrix

Skills Matrix is located on `/matrix` route. It consists of four steps in which users fill in their personal data and complete information about their skill level.

## Data source

Expand All @@ -40,7 +45,13 @@ Or connect your own preferable CMS or other data source.

For reference of data models used in the tech radar see types defined in `src/shared/components/radar/radar.types.ts`.

You can also import the data models into your own Contentful space with `contentful-cli` (see export file `contentful-export-2022-04-18.json`).
You can also import the data models into your own Contentful space with `contentful-cli` (see export file `contentful-export-2023-05-31.json`).

Skills Matrix is using AirTable to store and update users data.

To connect your AirTable table see `functions/.secret.example` file for required keys.

To structure your table see `functions/src/constants/airable.prod.ts` and `functions/src/constants/airtable.dev.ts`.

## Backend

Expand Down Expand Up @@ -77,6 +88,12 @@ In order for Firebase Functions to work properly you will also need to:
- Environment variables for Firebase Functions are coming from Google Secret Manager
Please take a look at `.secret.example` to see the required structure for it and upload them to Google Secret Manager for your application following these instructions: [Setting Firebase config](https://firebase.google.com/docs/functions/config-env#secret-manager)

## Admin Panel

Admin panel is very basic and it allows to update and add `entries` directly, instead of using contentful.
It is located on `/admin/panel` route.
Authorization is done by google account, which have admin role in contentful.

## Usage

### Node version
Expand Down
Loading