Skip to content

Commit

Permalink
📝 Update getting started doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Errorname
Errorname committed Jul 16, 2019
1 parent d596bde commit 51104c3
Show file tree
Hide file tree
Showing 34 changed files with 51 additions and 46 deletions.
34 changes: 17 additions & 17 deletions docs/assets.json
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
{
"app.css": "/FAQ/static/css/app.c90dfaa8cfc7e5adcef0.css",
"app.js": "/FAQ/static/js/app.0ba4d507.js",
"app.js.map": "/FAQ/static/js/app.c90dfaa8cfc7e5adcef0.js.map",
"index.js": "/FAQ/static/js/index.2a293f1f.js",
"index.js.map": "/FAQ/static/js/index.c90dfaa8cfc7e5adcef0.js.map",
"runtime~app.js": "/FAQ/static/js/runtime~app.c90dfaa8cfc7e5adcef0.js",
"runtime~app.js.map": "/FAQ/static/js/runtime~app.c90dfaa8cfc7e5adcef0.js.map",
"app.css": "/FAQ/static/css/app.b1ce0c083524ef40d530.css",
"app.js": "/FAQ/static/js/app.06bc94da.js",
"app.js.map": "/FAQ/static/js/app.b1ce0c083524ef40d530.js.map",
"index.js": "/FAQ/static/js/index.59b2a06a.js",
"index.js.map": "/FAQ/static/js/index.b1ce0c083524ef40d530.js.map",
"runtime~app.js": "/FAQ/static/js/runtime~app.b1ce0c083524ef40d530.js",
"runtime~app.js.map": "/FAQ/static/js/runtime~app.b1ce0c083524ef40d530.js.map",
"src-advanced-backing-services.js": "/FAQ/static/js/src-advanced-backing-services.2dd48d82.js",
"src-advanced-backing-services.js.map": "/FAQ/static/js/src-advanced-backing-services.c90dfaa8cfc7e5adcef0.js.map",
"src-advanced-backing-services.js.map": "/FAQ/static/js/src-advanced-backing-services.b1ce0c083524ef40d530.js.map",
"src-advanced-configuration.js": "/FAQ/static/js/src-advanced-configuration.ef1a5e27.js",
"src-advanced-configuration.js.map": "/FAQ/static/js/src-advanced-configuration.c90dfaa8cfc7e5adcef0.js.map",
"src-advanced-configuration.js.map": "/FAQ/static/js/src-advanced-configuration.b1ce0c083524ef40d530.js.map",
"src-advanced-contributing.js": "/FAQ/static/js/src-advanced-contributing.a08efd28.js",
"src-advanced-contributing.js.map": "/FAQ/static/js/src-advanced-contributing.c90dfaa8cfc7e5adcef0.js.map",
"src-advanced-contributing.js.map": "/FAQ/static/js/src-advanced-contributing.b1ce0c083524ef40d530.js.map",
"src-advanced-integrations.js": "/FAQ/static/js/src-advanced-integrations.ac08ecd1.js",
"src-advanced-integrations.js.map": "/FAQ/static/js/src-advanced-integrations.c90dfaa8cfc7e5adcef0.js.map",
"src-advanced-integrations.js.map": "/FAQ/static/js/src-advanced-integrations.b1ce0c083524ef40d530.js.map",
"src-advanced-multi-tenancy.js": "/FAQ/static/js/src-advanced-multi-tenancy.53a1c7fe.js",
"src-advanced-multi-tenancy.js.map": "/FAQ/static/js/src-advanced-multi-tenancy.c90dfaa8cfc7e5adcef0.js.map",
"src-getting-started.js": "/FAQ/static/js/src-getting-started.55d6c5b0.js",
"src-getting-started.js.map": "/FAQ/static/js/src-getting-started.c90dfaa8cfc7e5adcef0.js.map",
"src-advanced-multi-tenancy.js.map": "/FAQ/static/js/src-advanced-multi-tenancy.b1ce0c083524ef40d530.js.map",
"src-getting-started.js": "/FAQ/static/js/src-getting-started.8f4f6fa2.js",
"src-getting-started.js.map": "/FAQ/static/js/src-getting-started.b1ce0c083524ef40d530.js.map",
"vendors.js": "/FAQ/static/js/vendors.6481ef38.js",
"vendors.js.map": "/FAQ/static/js/vendors.c90dfaa8cfc7e5adcef0.js.map",
"static/js/10.dd8dcb68.js": "/FAQ/static/js/10.dd8dcb68.js",
"static/js/10.c90dfaa8cfc7e5adcef0.js.map": "/FAQ/static/js/10.c90dfaa8cfc7e5adcef0.js.map",
"vendors.js.map": "/FAQ/static/js/vendors.b1ce0c083524ef40d530.js.map",
"static/js/10.15745861.js": "/FAQ/static/js/10.15745861.js",
"static/js/10.b1ce0c083524ef40d530.js.map": "/FAQ/static/js/10.b1ce0c083524ef40d530.js.map",
"index.html": "/FAQ/index.html"
}
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<!doctype html><html lang="en"><head><meta charset="UTF-8"><meta name="description" content="Documentation for the FAQ project"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>🤔 FAQ Documentation</title><link rel="icon" type="image/x-icon" href="https://cdn-std.dprcdn.net/files/acc_649651/LUKiMl"><link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"><script src="https://use.fontawesome.com/releases/v5.0.6/js/all.js" type="text/javascript" defer="true"></script><link href="/FAQ/static/css/app.c90dfaa8cfc7e5adcef0.css" rel="stylesheet"></head><body><div id="root"></div><script src="/FAQ/static/js/runtime~app.c90dfaa8cfc7e5adcef0.js"></script><script src="/FAQ/static/js/vendors.6481ef38.js"></script><script src="/FAQ/static/js/app.0ba4d507.js"></script></body></html>
<!doctype html><html lang="en"><head><meta charset="UTF-8"><meta name="description" content="Documentation for the FAQ project"><meta name="viewport" content="width=device-width,initial-scale=1"><meta http-equiv="X-UA-Compatible" content="ie=edge"><title>🤔 FAQ Documentation</title><link rel="icon" type="image/x-icon" href="https://cdn-std.dprcdn.net/files/acc_649651/LUKiMl"><link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"><script src="https://use.fontawesome.com/releases/v5.0.6/js/all.js" type="text/javascript" defer="true"></script><link href="/FAQ/static/css/app.b1ce0c083524ef40d530.css" rel="stylesheet"></head><body><div id="root"></div><script src="/FAQ/static/js/runtime~app.b1ce0c083524ef40d530.js"></script><script src="/FAQ/static/js/vendors.6481ef38.js"></script><script src="/FAQ/static/js/app.06bc94da.js"></script></body></html>
2 changes: 2 additions & 0 deletions docs/index.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ route: /

Internal Knowledge Database for your organization - https://demo.faq.team

**:sparkles: Interested in having a hosted version of the FAQ for your organization? [Contact us!](mailto://[email protected])**

## What is FAQ?

**FAQ** is an **internal knowledge database** for your organization's members. It aims to be the **"single source of truth"** for most of your company-oriented information: _"How does the variable part of the salary work?"_, _"Can the client ask me to stay late at work?"_, ...
Expand Down
17 changes: 10 additions & 7 deletions docs/src/getting-started.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@ This project uses 2 `.env.local` file to configure its environment variables.
- The first `.env.local` file (for the frontend) needs to be created in the `client` folder.

```
REACT_APP_FAQ_URL=faq.zenika.com
REACT_APP_FAQ_URL=faq.team
REACT_APP_GRAPHQL_ENDPOINT=http://localhost:4000/gql
REACT_APP_REST_ENDPOINT=http://localhost:4000/rest
REACT_APP_PRISMA_SERVICE=default/default
```

Expand All @@ -55,11 +56,11 @@ PRISMA_API_SECRET=secret-42
PRISMA_MANAGEMENT_API_SECRET=my-secret-42
```

## 5/ Initialize local Prisma instance
## 5/ Run local Prisma and PostgreSQL instance

```bash
# Path: ./FAQ/server/prisma
PRISMA_MANAGEMENT_API_SECRET=my-secret-42 docker-compose up
# Path: ./FAQ/server
npm run local_containers
```

## 6/ Deploy and initialize your default service
Expand All @@ -68,15 +69,17 @@ You will need your Auth0 credentials for this step.

If you have a zenika.com email address, you can use the following credentials:

> `AUTH0_DOMAIN` = `zenika.eu.auth0.com`
> `AUTH0_DOMAIN=zenika.eu.auth0.com`
>
> `AUTH0_CLIENT_ID` = `wq8LU1f5iXQ4HWL0F6Z07QDcSMgWPd1p`
> `AUTH0_CLIENT_ID=wq8LU1f5iXQ4HWL0F6Z07QDcSMgWPd1p`
Otherwise, you can find them on your [Auth0 dashboard](https://manage.auth0.com).

**⚠️ Use your own domain & client id ⚠️**

```bash
# Path: ./FAQ/server
AUTH0_DOMAIN=your_domain AUTH0_CLIENT_ID=your_client_id npm run new_service
AUTH0_DOMAIN= AUTH0_CLIENT_ID= npm run new_service
```

## 7/ Run the backend
Expand Down
0 docs/static/css/app.c90dfaa8cfc7e5adcef0.css → docs/static/css/app.b1ce0c083524ef40d530.css
View file
File renamed without changes.
2 changes: 2 additions & 0 deletions docs/static/js/10.15745861.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/static/js/10.b1ce0c083524ef40d530.js.map
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion docs/static/js/10.c90dfaa8cfc7e5adcef0.js.map
View file

This file was deleted.

2 changes: 0 additions & 2 deletions docs/static/js/10.dd8dcb68.js
View file

This file was deleted.

Loading

0 comments on commit 51104c3

Please sign in to comment.