siraom15/spy-fall

Spy Fall game on website

Spy Fall

A game of Spyfall is made up of several short rounds. In each round the players find themselves in a certain location with a specific role assigned to each player. One player is always a spy who doesn't know where they are.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

Object of the Game

The spy's objective is to avoid exposure until the end of a given round or identify the current location. The non-spies' objective is to establish consensus on the identity of the spy and expose him or her.

(back to top)

Built With

• Vite
• Vue 3
• Tailwind CSS v3
• Vue Router v4
• Inter var font (self-hosted, woff2, v3.19, with 'preload' attr, check out index.html)
• Headless UI - unstyled, fully accessible UI components, designed to integrate beautifully with Tailwind CSS
• Heroicons - beautiful hand-crafted SVG icons, by the makers of Tailwind CSS
• prettier-plugin-tailwindcss - Automatic Class Sorting with Prettier
• Socket IO
• vue i18n

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

You also need to install serverside

1. Clone the repo

    git clone https://github.com/siraom15/spy-fall-client.git

2. Install NPM packages

    npm install

3. setup environment : VITE_APP_PORT, VITE_SERVER_URL in .env

    VITE_APP_PORT=3000
    VITE_SERVER_URL=https://spyfall-sv.herokuapp.com

4. Start your site

      npm run dev

5. Build your site

      npm run build
      npm run serve

(back to top)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)