⚠️ We will be right back soon ! If you want to contribute you can join us on discord ⚠️

sQuiz

View · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Twitch Authentication
3. Roadmap
4. Contributing
5. Contributors
6. License
7. Contact

About The Project

sQuiz.gg is an online multiplayer quiz about general culture.

Built With

• Expo
• Adonis
• Socket.io
• ... other awesome projects!

Getting Started

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

Prerequisites

• Expo
• Yarn
• Docker
• Docker compose

Installation

1. Clone the repo

   git clone https://github.com/sQuiz-2/Core.git

2. Init the project

   ./scripts/init

3. Start the project

   yarn start

Twitch Authentication

1. Create a Twitch app here
   • Name: sQuiz-dev
   • oAuth redirect URL: https://localhost:19006
   • Category: Website Integration
2. Replace the TWITCH_CLIENT_ID in packages/client/.env
3. Replace the TWITCH_CLIENT_ID and the TWITCH_CLIENT_SECRET in packages/backend/.env

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.

⚠️ Before starting a pull request, make sure your pull request will be related to an opened issue, if it's not the case please open an issue so we can discuss about it! 😉

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

Contributors

Thanks goes to these wonderful people (emoji key):

M4gie 💻 🎨 🚇

JulesD 💻

kahlys 💻

Worazme 💻 🖋

This project follows the all-contributors specification. Contributions of any kind welcome!!!

License

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

Contact

M4gie - @M4gie_