Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zenekezene/sleepy-spider

It's a game half clicker, half quiz. You have to achieve the highest possible score within a one-minute time limit. A creative experiment to test the capabilities of canvas and JS.
https://github.com/zenekezene/sleepy-spider

canvas javascript quizgame

Last synced: 2 months ago
JSON representation

It's a game half clicker, half quiz. You have to achieve the highest possible score within a one-minute time limit. A creative experiment to test the capabilities of canvas and JS.

Awesome Lists containing this project

README

        

[![Netlify Status](https://api.netlify.com/api/v1/badges/bb333221-55ae-4260-bbe8-5ae3b1980d7a/deploy-status)](https://app.netlify.com/sites/sleepy-spider/deploys)
[![Unit tests](https://github.com/sleepy-spider/sleepy-spider/actions/workflows/test-unit.yml/badge.svg?branch=main&event=push)](https://github.com/sleepy-spider/sleepy-spider/actions/workflows/test-unit.yml)
[![E2E Tests](https://github.com/sleepy-spider/sleepy-spider/actions/workflows/playwright.yml/badge.svg?branch=main&event=push)](https://github.com/sleepy-spider/sleepy-spider/actions/workflows/playwright.yml)

# SLEEPY SPIDER

### Oh, no! Sleepy has fallen into a deep sleep!
It's a game half clicker, half quiz. You have to achieve the highest possible score within a one-minute time limit.




# 🎮 How to play

Visit: https://bilbostack.zenekezene.com.

### Instructions to play

- Tap as many times in a minute to help Sleepy wake up.
- Answer questions correctly to get bonus points.
- Challenge your friends and try to be the best. You can login with your Twitter account.




---

# 💻 Only for developers

## 🌱 Installation

### Prerequisites
- ***Node v18 or higher***.

### How install
The ***all-in-one*** script to install and launch in development mode is defined below. But you can install front and back separately:
```
$ cd front
$ npm install

$ cd ../back
$ npm install
```

## 🚀 Getting started

### Development mode
#### All-in-one script (included installation)
To launch the dev mode, you can launch the all-in-one script called 'wakeup.sh'.
This script launches the front and back projects together.
```
$ ./wakeup.sh
```

#### Separately
You can launch back and front separately.
```
$ cd front
$ npm run dev

$ cd ../back
$ npm run start
```

#### View the project
Finally, you can open the frontend with your browser: `localhost:8000`.
The backend will be listening in `localhost:3000`.

---

## Production mode

### Front:
```
$ cd front
$ npm run build
```

### Library:
```
$ cd lib
$ npm run build
```
Note: You may want to publish a new version of the package (in npm public registry) and then install it in the front dependencies.
```
$ npm version X.X.X
$ npm publish
```

### Back:
Build process is not necessary. Only deploy the last version of back on your favorite server.
We uses Railway but you can use whatever.

#### Different environments
There are more instructions to generate differente API environment inside the subfolder [/back/README.md](./back/README.md).

#### API URL
https://css-api.up.railway.app/api/v1/questions

# 🛣️ Roadmap
Some next steps to include:

- Weekly challenges and gifts.
- Landing page.
- Replay game without reload.
- Legal notes.
- Night mode.

You can view the roadmap visiting this link: [Sleepy Spider, the pet project](https://zeneke.notion.site/Ara-a-b00b9e23adc445108bbe3744acfdf275).

# 💡 Idea
This project is an experiment to test the capabilities of canvas. It also serves as a challenge to practice using vanilla JS without the need for frameworks like React or Vue.

This project started like almost all of them: with pencil and paper.

Sketch one
Sketch two

---

# 🗣️ Stay in touch
- [Twitter](https://twitter.com/zenekezene)
- [Instagram](https://instagram.com/zenekezene)
- [Linkedin](https://www.linkedin.com/in/hectorvillarm/)

# Contribution
The main purpose of this repository is to continue learning JS and canvas posibilities. Development of Sleepy Spider happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

And you can help donating:

Buy Me A Coffee




## Contributors


Zeneke


Arturo Barba

---

# License
MIT License

Copyright (c) [2023] [@zenekezene, @arturobarbaro].

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Sleepy Spider