Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 629cde4

Browse filesBrowse files
committed
Update README.md
1 parent 19a5f5a commit 629cde4
Copy full SHA for 629cde4

File tree

Expand file treeCollapse file tree

1 file changed

+16
-1
lines changed
Filter options
Expand file treeCollapse file tree

1 file changed

+16
-1
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+16-1Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Authentication Flow uses `json web tokens` via Passport library - `passport-jwt`
1313
-`TypeScript`, `Joy` for validation
1414
-**Stack**: NodeJS / Express / SQLite / TypeORM
1515
- ✅ Auth: Passport / `passport-jwt` strategy
16+
- ✅ OAuth for Github
1617
- 🚀 `Instant Deploy` on RENDER using [Python Deployer](https://github.com/app-generator/deploy-automation-render)
1718
- `python.exe deployer.py nodejs <THIS_REPO>`
1819

@@ -78,6 +79,20 @@ $ yarn typeorm migration:run
7879

7980
<br />
8081

82+
> **Step 5** - Edit the `.env` using the template `.env.sample`.
83+
84+
```env
85+
PORT=5000 # API PORT
86+
SQLITE_PATH=./database.db # Path to the SQLite database file
87+
SECRET="Whatever-STRONG" # Secret for sensitive data hashing
88+
89+
# Same as for React APP
90+
GITHUB_OAUTH_CLIENT_ID= ... # Github OAuth secret
91+
GITHUB_OAUTH_CLIENT_SECRET= ... # Github OAuth secret
92+
```
93+
94+
<br />
95+
8196
> **Step 4** - Start the API server (development mode)
8297
8398
```bash
@@ -148,7 +163,7 @@ The SQLite Path is set in `.env`, as `SQLITE_PATH`
148163
$ yarn typeorm migration:generate -n your_migration_name
149164
```
150165

151-
> run migration:
166+
> Run migration:
152167
153168
```bash
154169
$ yarn typeorm migration:run

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.