Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opencodeiiita/wordout-backend
https://github.com/opencodeiiita/wordout-backend
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/opencodeiiita/wordout-backend
- Owner: opencodeiiita
- Created: 2024-12-11T12:51:14.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2024-12-31T07:40:40.000Z (9 days ago)
- Last Synced: 2024-12-31T08:26:49.145Z (9 days ago)
- Language: JavaScript
- Size: 114 KB
- Stars: 2
- Watchers: 1
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WordOut
WordOut is a thrilling multiplayer game where 5 to 8 players are assigned words related to a shared topic—except for one, the Imposter, who has a different word. Players must describe their words in 1 minute, convincing others they're in on the same topic. After every round, the group votes to eliminate someone, trying to eleminate the Imposter.
## 🧷Getting Started
- [Setup Git](https://git-scm.com/downloads)
- [Setup Node.js](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs)
- [Setup MongoDB](https://www.mongodb.com/docs/manual/installation/)
## ✒Tech Stack
* Flutter
* Node.js
## Claim an issue
Comment on the issue. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel.
## How To Contibute
We welcome your contributions. Please follow the below guidelines while contributing to this project:
1. Fork and star⭐ the repository and clone locally.
2. Create an upstream remote and sync your local copy before your branch. See detailed instructions [here](https://help.github.com/articles/syncing-a-fork)
3. Do the work and commit changes with good commit messages.
4. Once you are confident in your work, create a pull request to the `master` branch of the upstream repository with proper descriptions explaining what you did and wait until we review it😊.
> Check out [GitHub Flow](https://guides.github.com/introduction/flow/) for more details.
## 🛠️ How To Setup
1. Make sure you have an active internet connection – we’re diving deep into fandoms, after all!
2. Fork this repository to your GitHub account.
3. Clone your forked repository:
```bash
git clone
```
4. Navigate into the project directory:
```bash
cd WordOut-Backend
```
5. Install all necessary dependencies:
```bash
npm install
```
6. Set up your environment variables by creating a `.env` file in the root directory.
7. Start the development server:
```bash
npm start
```
8. You’re ready to explore! Access the backend application on `localhost:4000`.
## 📁 Directory Structure
```bash
.
├── server.js
├── package.json
├── package-lock.json
├── README.md
└── src
├── config
│ └── db.config.js
├── controllers
├── middlewares
├── routes
└── utils
```
## 🧾Common Rules:
- The repository is divided into several tasks. **Each task will be opened subsequently for a limited amount of time and all the submissions have to be made within those allotted days only.** NO submission will be accepted after the allotted time ends. The details for the specific tasks and the time allotted for each can be found in their specific issues.
- The submissions will be judged by the mentors and points🎉 will be allotted by them for each particular task based on various aspects like design thinking process, originality of the idea, visual appeal of the submission, code architecture etc.
- These tasks are for learning and not just scoring points so any kind of Plagiarism or attempt thereof wouldn't be tolerated and would lead to disqualification from OpenCode.
- **Your code should be error-free before creating a pull request.**
> ALL THE FINAL DECISIONS FOR THE JUDGMENT AND AWARDING OF POINTS ⚖️ BASED ON THE SUBMISSION RESIDE WITH THE MENTORS & ORGANISERS. No claim can be made on the number of points awarded by the Mentors & Organisers🙂.
## 🗒️Guidlines
Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
- Reference the issue numbers in the commit message if it resolves an open issue. Follow the pattern given in [PR_TEMPLATE.md](https://github.com/opencodeiiita/WordOut-Backend/blob/main/PR_TEMPLATE.md)
- Provide the relevant screenshot for easier review.
- Pull Request older than 2 days with no response from the contributor shall be marked closed.
## 📢Communication
Whether you are working on a new feature or facing a doubt please feel free to ask us on our [discord](https://discord.gg/D9999YTkS8) channel. We will be happy to help you out😊.
## ✒️Reference Links
- [Download and install the latest version of Git.](https://git-scm.com/downloads)
- [Set your username in Git.](https://help.github.com/articles/setting-your-username-in-git)
- [Set your commit email address in Git.](https://help.github.com/articles/setting-your-commit-email-address-in-git)
- [Setting up VS code](https://code.visualstudio.com/download)
- [Node.js Official Documentation](https://nodejs.org/docs/latest/api/)