Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrzzy committed Jul 25, 2024
1 parent 1bee3e3 commit 3ee578a
Showing 1 changed file with 50 additions and 1 deletion.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,51 @@
# art.mrzzy.co
art.mrzzy.co Website

Modern Artist Website.

## Description

Modern [JAMStack](https://jamstack.org/) Artist website to exhibit my art
and _potentially_ sell them.

Built with [React](https://react.dev) / [Next.js](https://nextjs.org/), [Radix](https://www.radix-ui.com/) / [shadcn](https://ui.shadcn.com/) UI components using [TypeScript](https://www.typescriptlang.org/).
[Hosted](https://github.com/mrzzy/nimbus/) on static files Backblaze B2 & behind Cloudflare CDN.

## Features

- Home page shows a random featured painting based on device orientation.
- Mobile responsive design.
- Modal gallery zoom view.

## Usage

Goto https://art.mrzzy.co and buy a painting.

## Contributing

Install dependencies

```sh
npm install --dev
```

Run development server

```sh
npm run dev
```

Unit tests

```sh
npm run test
```

Production build

```sh
npm run build
```

## License

MIT.

0 comments on commit 3ee578a

Please sign in to comment.