Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Latest commit

 

History

History
97 lines (67 loc) · 4.88 KB

README.md

File metadata and controls

97 lines (67 loc) · 4.88 KB

Browse the best mods in gaming from many sources on the Internet!

About This Project

An open-source website made by Christian Deacon that helps users find their favorite mods.

Please also check out the @modcommunity! They are doing things that will change the direction of gaming on a large scale by using modding and open source like never seen before!

Road Map

A road map for the website may be found here!

Each GitHub project represents a quarter and lists all things we're hoping to get completed by the end of said quarter.

Contributing

Any help from the open source community is highly appreciated on this project! We utilize the following.

  • Laravel (PHP and Back-End).
  • Tailwind CSS (HTML, CSS, and Front-End).
  • jQuery (JavaScript and Front-End).
  • DataTables (awesome jQuery library for loading millions of entries in a table).

Please take a look at our road map and join our Discord server for communication!

Our Community

Best Mods is ran by the The Modding Community which is a newer project taking modding to the next level by offering a unique marketplace, server and community browser & discovery, and forum! We have a Discord here if you want to socialize and interact with others including talented modders and content creators.

Additionally, you may also use our discussions forum here!

Social Media

Installation & Deployment

The project utilizes Laravel, Tailwind CSS, jQuery, and DataTables (for listing mods). Installation on a Linux server is fairly simple. However, I'd recommend making sure you have at least NodeJS 16.x, Composer 2.2.x, and NPM 8.x.x.

Additionally, we currently use Auth0 for authentication with a custom role-based system. Users with the Admin role may create mods, seeds, and games through the /create route.

# Install PHP and required packages.
sudo apt install php8.1-common php8.1-curl php8.1-mysql php8.1-xml php8.1-dom

# Clone the repository.
git clone https://github.com/BestMods/bestmods.git

# Change directory.
cd bestmods/

# Clear Composer cache in-case.
composer clear-cache

# Composer install.
composer install

# NPM install.
npm install

# Copy environment file.
cp .env.example .env

# SETUP DATABASE.
# MODIFY .env FILE :: Change database details, URL, and application name.

# Generate a key.
php artisan key:generate

# Migrate database.
php artisan migrate

# Seed database.
php artisan db:seed

# Build CSS and JS files.
npm run build

# Finally, serve to http://localhost:8000 for testing.
php artisan serve

# For production, set debug to false in .env file and use a proper web server such as NGINX or Apache!

# SETUP AUTH0 AND ADJUST DETAILS IN .env FILE.

Showcase

Credits