Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 5.96 KB

README.md

File metadata and controls

96 lines (73 loc) · 5.96 KB
Raw

Best Mods

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 all in one place! The website also includes Discord login authentication and the ability to upvote and downvote mods. Read more about us here!

Showcase

Desktop

Mobile

Road Map

A road map for the website may be found here!

Contributing

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

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

Our Community

Best Mods is ran by Christian Deacon and the The Modding Community. 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

Requirements

  • PostgreSQL (unless you choose SQLite; See below)
  • Node ^14
  • NPM

Using SQLite

To use a local SQLite database, perform the following steps.

  1. In prisma/schema.prisma, replace provider = "postgresql" with provider = "sqlite".
  2. In prisma/schema.prisma, remove all instances of @db.Text because PostgreSQL and SQLite have different column definitions for string.
  3. In .env, set DATABASE_URL to file:./db.sqlite.

Installation & Running Dev Server

You may perform the following commands to run the dev web server.

# Clone respository.
git clone https://github.com/bestmods/bestmods.git

# Change directory.
cd bestmods

# Update and install NPM packages.
npm update
npm install

# Migrate database.
npx prisma db push

# Run dev server.
npm run dev

Production

To run in production, you can use the npx next build command to build the web application. Make sure to add output: "standalone" to the config variable in next.config.mjs.

With that said, you may then run node server.js.

Permissions

While this project is open source, if you use this full project publicly, please add a link back to Best Mods' website that is visible to the public user. You don't need to do this if you're using <30% of the project's code. This is to attempt to mitigate people blatantly copying the project for their own use publicly.

Credits