diff --git a/README.md b/README.md index 9eea8f1..ca02842 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ -# Displacement X +# ▓ Displacement X -🚧🚧🚧 **under construction** 🚧🚧🚧 +Procedural displacement sci-fi maps generator. Web-based alternative to [JSplacement](https://www.google.com/search?q=JSplacement). -Procedural displacement sci-fi maps generator. +Live at ▶ **[displacementx.vercel.app](https://displacementx.vercel.app/)** + +Displacement X application screenshot + +## Status + +The application is still in development, but it's already usable to some extent. + +## Development + +Developers guide is available in [docs/DEVELOPMENT.md](docs/DEVELOPMENT.md). diff --git a/bun.lockb b/bun.lockb index 59dfa17..74697c6 100755 Binary files a/bun.lockb and b/bun.lockb differ diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md new file mode 100644 index 0000000..50a5513 --- /dev/null +++ b/docs/DEVELOPMENT.md @@ -0,0 +1,23 @@ +# Development + +The repository uses [Next.js](https://nextjs.org/) framework, so once you have some familiarity with it, it should be easy to work with this repository in general. + +## Pre-requisites + +- [Bun](https://bun.sh/) v1 + +## Quick start + +Install dependencies: + +```sh +bun i +``` + +Start local development server: + +```sh +bun run dev +``` + +Open [http://localhost:3000](http://localhost:3000) in the browser. diff --git a/docs/screenshot.png b/docs/screenshot.png new file mode 100644 index 0000000..287ecec Binary files /dev/null and b/docs/screenshot.png differ diff --git a/package.json b/package.json index 2cfd06d..8e873e1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "displacementx", - "version": "0.0.1-alpha.0", + "version": "0.0.1-alpha.1", "scripts": { "dev": "next dev", "build": "next build", @@ -11,6 +11,7 @@ "format": "prettier . --write" }, "dependencies": { + "@radix-ui/react-icons": "1.3.0", "@radix-ui/react-slider": "1.1.2", "@radix-ui/react-switch": "1.0.3", "clsx": "2.0.0", diff --git a/public/og.png b/public/og.png new file mode 100644 index 0000000..9c452bd Binary files /dev/null and b/public/og.png differ diff --git a/src/app/apple-icon.png b/src/app/apple-icon.png new file mode 100644 index 0000000..9a75690 Binary files /dev/null and b/src/app/apple-icon.png differ diff --git a/src/app/favicon.ico b/src/app/favicon.ico index 718d6fe..7c88bc7 100644 Binary files a/src/app/favicon.ico and b/src/app/favicon.ico differ diff --git a/src/app/icon.png b/src/app/icon.png new file mode 100644 index 0000000..1272a34 Binary files /dev/null and b/src/app/icon.png differ diff --git a/src/app/layout.tsx b/src/app/layout.tsx index 8a740a7..bcdf5a1 100644 --- a/src/app/layout.tsx +++ b/src/app/layout.tsx @@ -2,9 +2,32 @@ import type {Metadata} from 'next'; import {GeistSans} from 'geist/font'; import './style.css'; +const title = 'Displacement X'; +const description = 'Procedural displacement sci-fi maps generator'; +const images = [ + { + url: '/og.png', + alt: description, + width: 1200, + height: 630, + }, +]; + export const metadata: Metadata = { - title: 'Displacement X', - description: 'Procedural displacement sci-fi maps generator', + title, + description, + openGraph: { + title, + description, + siteName: title, + images, + }, + twitter: { + card: 'summary_large_image', + title, + description, + images, + }, }; export default function RootLayout({ diff --git a/src/components/pages/Generator/Generator.tsx b/src/components/pages/Generator/Generator.tsx index a334fa2..a1bc8cb 100644 --- a/src/components/pages/Generator/Generator.tsx +++ b/src/components/pages/Generator/Generator.tsx @@ -1,11 +1,24 @@ +import Link from 'next/link'; +import {GitHubLogoIcon} from '@radix-ui/react-icons'; import {CanvasSection} from './CanvasSection'; import {SettingsSection} from './SettingsSection'; export function Generator() { return (
-
+

Displacement X

+ + +