https://github.com/clovisdasilvaneto/takeway-scoober

https://github.com/clovisdasilvaneto/takeway-scoober

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/clovisdasilvaneto/takeway-scoober
• Owner: clovisdasilvaneto
• Created: 2024-02-29T22:30:48.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-04T21:42:44.000Z (9 months ago)
• Last Synced: 2024-03-05T17:31:45.253Z (9 months ago)
• Language: TypeScript
• Homepage: https://takeway-scoober.onrender.com/login
• Size: 4.83 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This repo is a outcome of the just takeway scoober game challange. You can access the [online project here](https://takeway-scoober.onrender.com/login)

## Architectural Diagram

You can find an architectural diagram with user flows and project architecture in the following link: [https://excalidraw.com/#json=cJLZIVA0PO7Doe1PmcFHz,xemJrXdLxQw26QRJm43ZYQ

](https://excalidraw.com/#json=cJLZIVA0PO7Doe1PmcFHz,xemJrXdLxQw26QRJm43ZYQ)







and more...

## Storybook with custom design system

This projects uses MaterialUI as design system but since we have customized components, a storybook containing these components was created. You can find it here: [https://takeway-scoober-storybook.onrender.com](https://takeway-scoober-storybook.onrender.com)

## Screenshots

You can find screenshots of this project in the [readme-assets folder.](https://github.com/clovisdasilvaneto/takeway-scoober/tree/main/readme-assets)

Here you have some examples about how the game works:















and more...

## How to run locally?

First, rename your `.env.sample` to be `.env` then run the development server:

```bash

npm run dev

# or

yarn dev

# or

pnpm dev

# or

bun dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.