Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
ci

ci

ci

ci

ci

README

README

fix
  • Loading branch information
bramtechs committed Nov 19, 2024
1 parent 81d7400 commit 627c28e
Show file tree
Hide file tree
Showing 8 changed files with 73 additions and 5 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Deploy Vite App to GitHub Pages

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
# Checkout the repository
- name: Checkout repository
uses: actions/checkout@v3

# Set up Node.js and Yarn
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 18 # Use the desired Node.js version
cache: "yarn"

# Install dependencies with Yarn
- name: Install dependencies
run: yarn install

# Build the Vite project
- name: Build project
run: yarn build

# Deploy to GitHub Pages
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: dist
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
/node_modules
/.pnp
.pnp.js
dist

# testing
/coverage
Expand Down
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,36 @@
# Starship 58 Adventure

<a href="https://bramtechs.github.io/Starship58Adventure/" target="_blank">Play
in your browser!</a>

Original code for a game programmed in 5 hours for
[Hack The Future 2024](https://www.hackthefuture.be/), a Belgian Hackathon.

Developed in a team of two, made in ThreeJS and React.
Developed in a team of two, made in ThreeJS, Boostrap and React.

## Scenario

translated from Dutch

Major Tom and his team are running out of oxygen and need your help to find the
fastest way to 2MASS J23062928-0502285, also known as TRAPPIST-1. You are the
head of the ground control center on Earth and are in charge of using all the
data you receive from the spacecraft. Use this data as best you can to get
everyone safely to their destination before they run out of oxygen. Are you
ready to lead this life-saving mission?

## Screenshots

<img src="./misc/screenshot02.webp" max-height="350px" width="auto">
<img src="./misc/screenshot01.webp" max-height="350px" width="auto">
<img src="./misc/screenshot03.webp" max-height="350px" width="auto">
<img src="./misc/screenshot04.webp" max-height="350px" width="auto">

---

<details>
<summary>Original readme</summary>

# Starship 58 Adventure React TypeScript App

Welcome aboard Starship 58, cadet! This React TypeScript app simulates a journey
Expand Down Expand Up @@ -139,3 +165,5 @@ will control the rocket's navigation.

Your journey through the stars awaits. Use your skills to navigate the vastness
of space, overcome obstacles, and achieve your mission. May the stars guide you!

</details>
Binary file added misc/screenshot01.webp
Binary file not shown.
Binary file added misc/screenshot02.webp
Binary file not shown.
Binary file added misc/screenshot03.webp
Binary file not shown.
Binary file added misc/screenshot04.webp
Binary file not shown.
9 changes: 5 additions & 4 deletions vite.config.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import { defineConfig } from 'vite';
import react from '@vitejs/plugin-react';
import path from 'path';
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
import path from "path";

export default defineConfig({
plugins: [react()],
base: "Starship58Adventure",
resolve: {
alias: {
'@': path.resolve(__dirname, './src'),
"@": path.resolve(__dirname, "./src"),
},
},
server: {
Expand Down

0 comments on commit 627c28e

Please sign in to comment.