thebongy/sike-service

Backend repository for Sike

sike-service

The popular game Psych made better!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contributors

About The Project

We’re sure you’ve played PSYCH!, a fun guessing game by Ellen DeGeneres, where trivia meets Cards Against Humanity. Then you must also be aware of how the game recently has become increasingly monetized making it a bit difficult to play it your friends.

We have developed a website to get your needs covered with this website version of PSYCH!. Choose from a variety of fun and hilarious categories, such as “The Truth Comes Out,” in which you and your friends become the game! Get ready to answer funny and ridiculous questions about one another.

Sike! is the perfect free website for family or friends game night, Zoom calls, road trips, or even waiting in line! Grab your devices, gather ‘round, and get ready for a gaming experience unlike any other house party game you’ve ever played!

Built With

• express
• nodemon
• joi
• uuid
• mongoose
• socket.io
• winston

Getting Started

To get a local copy up and running follow these simple steps.

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

• Typescript

npm install -g typescript

Installation

1. Clone the repo

git clone https://github.com/ashikka/sike-service.git

2. Install NPM packages

npm install

3. Add necessary environment variables to .env file.

{
        echo 'PORT='
        echo 'DB_URL='
} >> .env

Usage

1. Create room

POST /room/join

Parameter	Type	Description
body	string	username
body	number	rounds

Response format

{
    "success": true,
    "message": "Game created successfully",
    "data": {
        "rounds": 1,
        "roomId": "someRandomUUID",
        "creator": "creatorName"
    }
}

2. Join a created room

POST /room/join/:roomId

Parameter	Type	Description
body	string	username

Response Format

{
    "success": true,
    "message": "Room joined successfully",
    "data": {
        "players": 4,
        "roomId": "someRandomUUID"
    }
}

Roadmap

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

Contributing

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

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

You are requested to follow the contribution guidelines specified in CONTRIBUTING.md while contributing to the project 😄.

License

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