Skip to content

Commit b25afa4

Browse files
update readme header
1 parent 4462b7a commit b25afa4

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
![Alt text](github-images/DICTIONATOR.png?raw=true "Title")
44

5-
## 👋 Introduction
5+
# 👋 Introduction
66

77
A Web-Based tool for generating Salesforce Data Dictionary supported with Oath2 Salesforce Authentication. This tool will help Salesforce Developer/Administrator to visualize their Schema Object field's pre-selected important attributes rather than visiting Salesforce Object Manager. It can export multiple schema objects to excel with fancy cell color and a Datatable for viewing the selected Schema Object.
88

9-
### Tech Stack:
9+
# Tech Stack:
1010

1111
- [x] [Next.js](https://nextjs.org/)
1212
- [x] [NextAuth.js](https://next-auth.js.org)
@@ -16,7 +16,7 @@ A Web-Based tool for generating Salesforce Data Dictionary supported with Oath2
1616
- [x] [Typescript](https://www.typescriptlang.org/)
1717
- [x] [Flowbite React Components](https://flowbite-react.com/)
1818

19-
## 📷 Screen Shots
19+
# 📷 Screen Shots
2020

2121
![Alt text](github-images/ss_01.png?raw=true "Title")
2222

@@ -36,7 +36,7 @@ Figure 2 - SObject Datatable
3636
Figure 3 - Exported Excel File
3737
</p>
3838

39-
## ⚡️ One-click Deployment to your own Vercel Account
39+
# ⚡️ One-click Deployment to your own Vercel Account
4040

4141
Using the Vercel Deploy Button, you can quickly deploy this project into your own Vercel Account.
4242

@@ -50,9 +50,9 @@ After clicking the Deploy button above, it will redirect to your Vercel Account,
5050
2. Next, it will proceed on setting up the **[Environment Variables](https://github.com/pelayochristian/sf-dictionator#environment-variables)** needed to this project to run smoothly, then click **Deploy**
5151
![Alt text](github-images/vercel_add_env_var.png?raw=true "Vercel Add Environment Variables")
5252

53-
## 🧑‍🔧 Pre-Work
53+
# 🧑‍🔧 Pre-Work
5454

55-
### Create Connected App in Salesforce
55+
## Create Connected App in Salesforce
5656

5757
1. Log in to Salesforce as an administrator.
5858
2. In the drop-down list of the account (in the upper-right corner), select **Setup**.
@@ -76,7 +76,7 @@ After clicking the Deploy button above, it will redirect to your Vercel Account,
7676
9. Go back to the **Connected Apps** list, and click the App that you just created.
7777
10. Go to **API (Enable OAuth Settings)**, and note down the **Consumer Key** and **Consumer Secret**, which will be used for the configuration of **[Environment Variables](https://github.com/pelayochristian/sf-dictionator#environment-variables)**.
7878

79-
## 🧑‍💻 Environment Variables
79+
# 🧑‍💻 Environment Variables
8080

8181
For local installation, create `.env.local` in root folder of the project.
8282

@@ -91,17 +91,17 @@ NEXTAUTH_SECRET=YOUR_NEXTAUTH_SECRET
9191

9292
To generate NextAuth Secret you can use this app: https://generate-secret.vercel.app/32
9393

94-
## 🛑 Security
94+
# 🛑 Security
9595

96-
### How is your token being used or stored?
96+
## How is your token being used or stored?
9797

9898
On this tool, your token is not stored in any databases. With the use of Next-Auth after the Salesforce Authenticate the user, using JWT provided by the Next-Auth only the token is used, and the session with a maximum TTL of 2 hours.
9999

100-
### How can we keep the user still log in after 2 hours straight with active session?
100+
## How can we keep the user still log in after 2 hours straight with active session?
101101

102102
By using [Refresh Rotation Strategy](https://next-auth.js.org/tutorials/refresh-token-rotation) and refresh the token with a 15 minutes buffer time before the expiration of the token.
103103

104-
## ⚡️ Local Machine Installation
104+
# ⚡️ Local Machine Installation
105105

106106
Before firing up the project make sure you already set your **[Environment Variables](https://github.com/pelayochristian/sf-dictionator#environment-variables)**.
107107

@@ -111,13 +111,13 @@ cd sf-dictionator
111111
npm install
112112
```
113113

114-
### For Development, run the below command.
114+
## For Development, run the below command.
115115

116116
```
117117
npm run dev
118118
```
119119

120-
### For running the Production Ready package, run the below command.
120+
## For running the Production Ready package, run the below command.
121121

122122
```
123123
npm run build && npm run start

0 commit comments

Comments
 (0)