Skip to content

Commit

Permalink
update todo, add note on cookie
Browse files Browse the repository at this point in the history
  • Loading branch information
creme332 committed Dec 15, 2023
1 parent 9c392f3 commit 534ad6f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,16 @@
![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB)

A real-time collaborative pixel art creation website built with MERN stack. This project was inspired by [`r/place`](https://en.wikipedia.org/wiki/R/place).
A real-time collaborative pixel art creation website built with MERN stack. This project was inspired by [`r/place`](https://en.wikipedia.org/wiki/R/place). Check out my [blog post](https://creme332.github.io/creamy-notes/posts/art98) to learn more about this project.

![GIF of website](screenshots/art98.gif)

[Live Preview ▶](https://art98.vercel.app)

[View screenshots 📷](screenshots)

> 🔴 **Note**: art98 uses cookies to make requests to the server. If cookies are disabled on your browser or if you are using an incognito tab, you will not be able to login.
> 🟡 **Note**: Actions such login and registering will take a few seconds to complete initially because the server spins down with inactivity and needs to spin back up after the first request. This is because the backend is hosted on a free instance type on Render.
> 🔴 **Disclaimer**: The artwork displayed on this website is user-generated and collaborative. Some content might be inappropriate or offensive. Please be aware that the images presented do not necessarily reflect my views.
Expand Down Expand Up @@ -67,10 +69,11 @@ ADMIN_KEY="" # secret passkey needed to become admin user
PREMIUM_KEY="" # secret passkey needed to become premium user
```

Inside `server` directory, to populate your database:
Navigate to the `server` directory and populate your database:
```bash
npm run populate
```
This should take 2-3 minutes.

## Usage
In one terminal, start frontend:
Expand Down Expand Up @@ -104,7 +107,7 @@ Open [http://localhost:3000](http://localhost:3000) in your browser to see runni

## To-do
- [ ] Refactor `server.js`
- [ ] Possible bug: What if a user joins while canvas is being cleared? (database does not clear canvas instantly)
- [ ] Add how to play section on website
- [ ] Add new admin privilege: use custom colors on top of color palette
- [ ] Add download canvas option
- [ ] Rewrite backend in typescript
Expand Down

0 comments on commit 534ad6f

Please sign in to comment.