janis/explainegy-nextjs
1
0
Fork 0
mirror of https://github.com/DerTyp7/explainegy-nextjs.git synced 2025-10-29 12:52:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Janis
2023-07-23 01:07:41 +02:00
parent 30b93c3a06
commit 45eb8b3914
2 changed files with 18 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -4,15 +4,28 @@ Markdown-based tutorials and articles webapp, built using Docker, NextJS & Prism
## Getting Started
1. Create a `.env` file in the root directory and add the following variables:
1. Register a new OAuth app on GitHub: <https://github.com/settings/applications/new>
1. Set the "Homepage URL" to `http://localhost:3000`
2. Set "Authorization callback" URL to `http://localhost:3000/api/auth/callback`
2. Create a `.env` file in the root directory and add the following variables:
```bash
DATABASE_URL="postgresql://postgres:postgres@localhost:5432/postgres?schema=explainegy"
AUTH_GH_CLIENT_ID="abc"
AUTH_GH_CLIENT_SECRET="abcdef"
AUTH_DEBUG_GH_ADMIN_ID="123" # The GitHub user ID of the admin user
```
2. Run the following commands:
> Note: `AUTH_DEBUG_GH_ADMIN_ID` can be optaind here: <https://api.github.com/users/your-username>
3. Run the following commands:
```bash
docker compose up -d
npm run dev
```
4. Login as admin using your GitHub account: <http://localhost:3000/api/auth/signin>
5. Use the webapp: <http://localhost:3000/>