Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j3fftw1/j3fftw.dev

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/j3fftw1/j3fftw.dev
Owner: J3fftw1
Created: 2020-12-13T21:50:22.000Z (about 4 years ago)
Default Branch: master
Last Pushed: 2024-03-02T08:01:32.000Z (10 months ago)
Last Synced: 2024-10-12T03:49:23.173Z (2 months ago)
Language: TypeScript
Size: 1.45 MB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Terminal Portfolio Website by Sat Naing

![Terminal Portfolio Website by Sat Naing](https://user-images.githubusercontent.com/53733092/194220661-e2ff8b4c-f64a-4b64-a836-c52fae6bbcda.png)

![ts](https://badgen.net/badge/Built%20With/TypeScript/blue?style=flat-square)

[![Netlify Status](https://api.netlify.com/api/v1/badges/81fdb91d-c06f-46c2-b18d-dfc6f090f281/deploy-status)](https://app.netlify.com/sites/terminal-sn/deploys)

![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square)

My perfolio website in terminal version developed with React, TypeScript and Styled-Components. Multiple themes supported and keyboard shortcuts can be used for some functionalities.

Blog Post: https://satnaing.dev/blog/posts/how-do-i-develop-my-terminal-portfolio-website-with-react

## Features

- Responsive Design 📱💻

- Multiple themes 🎨

- Autocomplete feature ✨ (TAB | Ctrl + i)

- Go previous and next command ⬆️⬇️

- View command history 📖

- PWA and Offline Support 🔥

- Well-tested ✅

## Tech Stack

**Frontend** - [React](https://reactjs.org/), [TypeScript](https://www.typescriptlang.org/)  

**Styling** - [Styled-Components](https://styled-components.com/)  

**UI/UX** - [Figma](https://figma.com/)  

**State Management** - [ContextAPI](https://reactjs.org/docs/context.html)  

**Testing** - [Vitest](https://vitest.dev/), [React Testing Library](https://testing-library.com/)  

**Deployment** - [Netlify](https://app.netlify.com/)

## Multiple Themes

Currently, this website supports 6 themes. Type `themes` in the terminal for more info.

![terminal-portfolio-themes](https://user-images.githubusercontent.com/53733092/194221801-94f1c28b-4865-4b7f-a73e-d41132519bea.png)

## Lighthouse Score







## Running Locally

Clone the project

```bash

git clone https://github.com/satnaing/terminal-portfolio.git

```

Go to the project directory

```bash

cd terminal-portfolio

```

Remove remote origin

```bash

git remote remove origin

```

Install dependencies

```bash

npm install

```

Start the server

```bash

npm run dev

```

## Inspiration and Credits

Here are some inspiration for this kind of terminal website. Only some features and functionalities are inspired by these following websites. All codes are written on my own.

- [term m4tt72](https://term.m4tt72.com/)

- [Forrest](https://fkcodes.com/)

## Author

- [@satnaing](https://satnaing.dev)