Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 2.31 KB

README.md

File metadata and controls

83 lines (52 loc) · 2.31 KB
Raw

UltiMafia

This is the source code powering UltiMafia.com, a website built to provide online chat mafia to all.

Contributing

  1. Fork the repository
  2. Make your changes to your forked repository
  3. Open a pull request on the master branch of this repository
  4. Perform a final test on the main site after merge into master

Running the site locally

If you are a beginner, please follow this beginner guide and ask in Discord if you are stuck at any step.

Prerequisites

  1. Install node.js, and set the version to v14.15.1.

  2. Install MongoDB and Redis and run them as services. If using Windows, install Memurai instead of Redis. You can refer to this guide for setting up MongoDB and Redis via docker.

  3. Clone your forked repository. Replace "UltiMafia" with your github username.

git clone https://github.com/UltiMafia/Ultimafia.git

Install node modules

  1. Install pm2 globally.
npm i -g pm2
  1. Install backend node modules.
cd Ultimafia
npm install
  1. Install frontend node modules.
cd react_main
npm install

Setup environment variables

  1. Create .env file for the server under Ultimafia/.env, and copy this example file

  2. Create a .env file for the React app under Ultimafia/react_main/.env and copy this example file

  3. Refer to this guide for retrieving your own test API keys for Firebase and reCAPTCHA.

Start the site

  1. Start the backend server
cd Ultimafia
npm start
  1. Start the frontend React app
cd react_main
npm start

Role and game creation

This site is based on the code provided by r3ndd from this repository and is used under the Creative Commons license (Attribution-NonCommercial-ShareAlike 4.0 International). It has been changed and is not affiliated with the creator or the website that uses the original repository's code.

Contributors

Music is by Fred, check out his youtube @fredthemontymole