Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 37 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
# Canvas Tile Placement Website

Welcome to the Canvas Tile Placement website! This platform allows users to contribute to a shared canvas by placing colored tiles. Whether you choose to register or continue as a guest, you can make your mark on the canvas with the color of your choice.

## Getting Started

### Registration

- To contribute to the canvas, you have the option to **register** or continue as a **guest**.
- If you choose to register, follow the on-screen instructions to create an account.

### Guest Contribution

- If you prefer not to register, simply click on "**Continue as Guest**" on the homepage.

## Contributing to the Canvas

1. After registration or selecting the guest option, you will be directed to the canvas contribution page.
2. The canvas provides a range of colors for you to choose from.
3. Select your preferred color from the **palette**.

## Placing a Tile

- Click on any tile within the canvas to place your selected color.
- The canvas is shared among all users, so your contribution will be visible to everyone.

## Features

- **User-Friendly Interface:** The website provides an intuitive interface for seamless navigation.
- **Color Palette:** A diverse range of colors is available for users to choose from.
- **Shared Canvas:** All users contribute to the same canvas, creating a collaborative and dynamic art piece.

# Tiles

Inspired by `r/place`, Idea by [Fawaz](https://github.com/fauwara) brought to you by [Deveesh Shetty](https://github.com/Deveesh-Shetty). Collaborate in the canvas, unleash your creativity, and enjoy!

Checkout live - [placetile.vercel.app](https://placetile.vercel.app) hosted using Vercel and Render

## Set the project locally
- Fork and Clone the project
- This project uses pnpm as a package manager, if you don't have it install it using
```bash
npm install -g pnpm
```
- Inside both the `client` and `api/` folder copy `.env.example` to `.env` and fill the required fields.
- Install the dependencies on the client side and run the frontend server
```bash
cd client/
pnpm i
pnpm run dev
```
- Open a new terminal, and install dependencies and run the backend server
```
cd api/
pnpm i
pnpm run dev
```
- You can now run the project locally and make changes 🥳

![Tile Canvas](https://github.com/Deveesh-Shetty/tiles/assets/89470104/cff6b7b0-f107-411f-a22a-d69a56c776df)
## Live Demo

Checkout live - [placetile.vercel.app](https://placetile.vercel.app)

Feel free to explore, contribute, and be part of the collaborative canvas!
4 changes: 0 additions & 4 deletions api/.env.example

This file was deleted.

3 changes: 0 additions & 3 deletions client/.env.example

This file was deleted.