fix: adding documentation to create your own env file

.gitignore

@@ -65,4 +65,8 @@ yarn-error.log*
 .vercel
 
 # typescript
-*.tsbuildinfo
+*.tsbuildinfo
+
+# local env files
+.env*.local
+.env

README.md

@@ -63,7 +63,8 @@ We need now to get a personal token from your github account.
 4) Type a note and click on `public repo`.
 5) Click on Generate token.
 6) Then copy token generated that start with `ghp_`.
-7) Copy in file `.env`, after variable `API_TOKEN=`.
+7) Create a new file name `.env` in folder `github-history/backend/`
+8) Paste token in file `.env`, after variable `API_TOKEN=`.
 
 ### Running server
 Commands to run backend server, use `start:dev` if you want to automatically reset server after saving changes.

backend/src/app.service.ts

@@ -13,7 +13,7 @@ export class AppService {
   };
 
   getUser(user: string): Promise<any> {
-    const userUrl = this.env.get<string>('API_USERS');
+    const userUrl = this.env.get<string>('https://api.github.com/users');
     return lastValueFrom(
       this.http.get<any>(`${userUrl}/${user}`, { headers: this.header }).pipe(
         map((res) => res.data),
@@ -27,7 +27,7 @@ export class AppService {
   }
 
   getRepos(user: string): Promise<any> {
-    const userUrl = this.env.get<string>('API_USERS');
+    const userUrl = this.env.get<string>('https://api.github.com/users');
     return lastValueFrom(
       this.http
         .get<any>(`${userUrl}/${user}/repos`, { headers: this.header })
@@ -43,7 +43,7 @@ export class AppService {
   }
 
   getBranches(user: string, repo: string): Promise<any> {
-    const branchUrl = this.env.get<string>('API_REPOS');
+    const branchUrl = this.env.get<string>('https://api.github.com/repos');
     return lastValueFrom(
       this.http
         .get<any>(`${branchUrl}/${user}/${repo}/branches`, {
@@ -61,7 +61,7 @@ export class AppService {
   }
 
   getCommits(user: string, repo: string, branch: string): Promise<any> {
-    const commitUrl = this.env.get<string>('API_REPOS');
+    const commitUrl = this.env.get<string>('https://api.github.com/repos');
     return lastValueFrom(
       this.http
         .get<any>(`${commitUrl}/${user}/${repo}/commits?sha=${branch}`, {

backend/src/main.ts

@@ -2,7 +2,7 @@ import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';
 
-const PORT = process.env.PORT;
+const PORT = process.env.PORT || 8080;
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule, { cors: true });

frontend/.gitignore

@@ -30,3 +30,6 @@ yarn-error.log*
 
 # typescript
 *.tsbuildinfo
+
+# local env files
+.env*.local

frontend/pages/index.tsx

@@ -5,7 +5,7 @@ import Image from "next/image";
 import { useEffect, useState } from "react";
 import styles from "../styles/Home.module.css";
 
-const serverUrl = process.env.NEXT_PUBLIC_SERVER_URL;
+const serverUrl = process.env.NEXT_PUBLIC_SERVER_URL || "http://localhost:8080";
 
 /**
  * Home Page