https://github.com/9inpachi/my-planet
A small planet with procedurally generated objects.
https://github.com/9inpachi/my-planet
Last synced: 4 months ago
JSON representation
A small planet with procedurally generated objects.
- Host: GitHub
- URL: https://github.com/9inpachi/my-planet
- Owner: 9inpachi
- Created: 2022-04-14T18:49:27.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-14T19:27:26.000Z (6 months ago)
- Last Synced: 2024-12-14T20:25:03.809Z (6 months ago)
- Language: TypeScript
- Homepage: https://fawadali.dev
- Size: 10.2 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# My Planet
A small planet with procedurally generated objects placed over continents.
## Setup
Make sure you have [Node.js](https://nodejs.org/en/download) and [yarn](https://classic.yarnpkg.com/lang/en/docs/install/) installed.
Install dependencies and start the application.
```sh
yarn install
yarn start
```
Navigate to [http://localhost:5173](http://localhost:5173) on the browser to access the application.
## Release
[Release It!](https://github.com/release-it/release-it) is used to release the application. Use the following command to initiate the release.
```sh
yarn release
```
It will create a new tag and a draft release. Manually pubishing the draft release will trigger a [GitHub Actions workflow](./.github/workflows/deploy.yml) which will deploy the application on the `gh-pages` branch using GitHub Pages.
## Architecture
