refactor: simplify to static site with Gist config

Author: nirabo

.env.example

@@ -1,11 +1,9 @@
+# System files
 .DS_Store
-node_modules/
-.env
-.env.local
-.env.*.local
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
 .vscode/
+
+# Dependencies
+node_modules/
+
+# Logs
 *.log
-*.mp3

.gitignore

@@ -1,14 +1,20 @@
 # Terminal Portfolio
 
-A terminal-style portfolio website template that loads your personal data from a GitHub Gist at build time, keeping your information private while maintaining a clean, reusable template.
+A terminal-style portfolio website that loads personal data from a GitHub Gist, providing a clean separation between the UI template and your content.
+
+## How It Works
+
+1. The UI is a simple static website that mimics a terminal interface
+2. Your personal data (projects, skills, etc.) lives in a GitHub Gist
+3. The site loads your data from the Gist at runtime
+4. Update your Gist to change your portfolio content
 
 ## Quick Start
 
-1. Use this template:
+1. Fork this repository:
    ```bash
    git clone https://github.com/nirabo/nirabo.github.io.git
    cd nirabo.github.io
-   npm install
    ```
 
 2. Create your configuration:
@@ -18,109 +24,74 @@ A terminal-style portfolio website template that loads your personal data from a
    - Make sure to select "JSON" as the file type
    - Save the Gist and copy its "Raw" URL
 
-3. Set up configuration:
-   ```bash
-   cp .env.example .env
-   ```
-   Edit .env and set your Gist URL:
-   ```
-   PORTFOLIO_CONFIG_URL=your-gist-raw-url
-   ```
+3. Update configuration:
+   - Edit `config.js` to point to your Gist URL
 
-4. Build and deploy:
-   ```bash
-   npm run build
-   ```
+4. Deploy:
    - Rename your repository to `yourusername.github.io`
    - Push to GitHub
    - Your site will be available at `https://yourusername.github.io`
 
-## Development
-
-1. Start local server:
-   ```bash
-   npm start
-   ```
-   This will serve the site at http://localhost:8080
+## Available Commands
 
-2. Making changes:
-   - Update your Gist with new information
-   - Run `npm run build` to update the configuration
-   - Test locally before deploying
+The terminal supports these commands:
+- `help`: List all commands
+- `about`: Display personal information
+- `projects`: List all projects
+- `project [name]`: Show details of a specific project
+- `contact`: Display contact information
+- `skills`: List technical skills
+- `clear`: Clear the terminal
+- `ls`: List available sections
 
 ## Configuration Structure
 
-The `config.template.js` shows the expected structure. Here's what to customize:
-- Update your name, role, and bio in the `about` section
-- Add your contact information
-- List your skills
-- Add your projects with descriptions and links
-- Customize available commands
-- (Optional) Add your custom ASCII art
-
-Your configuration file (whether local, external, or template) should follow this structure:
+Your Gist should follow this structure:
+```javascript
+{
+    "about": {
+        "name": "Your Name",
+        "role": "Your Role",
+        "bio": "Your Bio",
+        "skills": ["Skill 1", "Skill 2"]
+    },
+    "contact": {
+        "email": "[email protected]",
+        "github": "github.com/yourusername"
+    },
+    "projects": [
+        {
+            "name": "Project Name",
+            "description": "Project Description",
+            "technologies": ["Tech1", "Tech2"],
+            "period": "2023-2024"
+        }
+    ]
+}
+```
 
 ## Local Development
 
-Since the project uses ES modules, you'll need to serve it through a local server. You can use any of these methods:
+Since the project uses ES modules, you'll need to serve it through a local server:
 
-- Python 3:
 ```bash
+# Using Python 3
 python -m http.server
-```
 
-- Node.js (with `http-server`):
-```bash
+# Or using Node.js
 npx http-server
 ```
 
 Then open `http://localhost:8000` in your browser.
 
-## Available Commands
-
-The terminal supports these default commands:
-- `help`: List all available commands
-- `about`: Display personal information
-- `projects`: List all projects
-- `project [name]`: Show details of a specific project
-- `contact`: Display contact information
-- `skills`: List technical skills
-- `clear`: Clear the terminal
-- `ls`: List available sections
-
 ## Customization
 
-### Adding New Commands
-
-1. Add the command to the `commands.help` section in your `config.js`
-2. Add the command handler in `script.js`
-
-### Styling
-
 Modify `style.css` to customize the terminal's appearance:
 - Colors
 - Font family
 - Terminal dimensions
 - Prompt style
 
-## Deployment
-
-The site is ready for GitHub Pages deployment. Just push your changes to the main branch:
-
-```bash
-git add .
-git commit -m "Update site configuration"
-git push origin main
-```
-
-Your site will be available at `https://yourusername.github.io`
-
-## Privacy
-
-- Your personal data in `config.js` is kept private and not tracked by git
-- The repository only contains the template and structure
-- Each user can maintain their own private configuration
-
 ## License
 
 MIT License - Feel free to use this template for your own portfolio!

README.md

@@ -0,0 +1,3 @@
+// Configuration URL for the portfolio
+// This points to a GitHub Gist containing the portfolio data
+export const CONFIG_URL = "https://gist.githubusercontent.com/nirabo/fe75cf5bcf4b371aceeb9033d23d4070/raw/8f5947e3b61b69498c08921f3fbc35ad0b95d1e7/portfolio-config.json";

build.js

@@ -14,10 +14,6 @@
             <input type="text" id="command-input" autofocus autocomplete="off">
         </div>
     </div>
-    
-    <script>
-        window.PORTFOLIO_CONFIG_URL = "https://gist.githubusercontent.com/nirabo/fe75cf5bcf4b371aceeb9033d23d4070/raw/8f5947e3b61b69498c08921f3fbc35ad0b95d1e7/portfolio-config.json";
-    </script>
-<script type="module" src="script.js"></script>
+    <script type="module" src="script.js"></script>
 </body>
 </html>