https://github.com/bestmods/bestmods
An open source website that allows users to browse mods in gaming from many sources on the Internet! Made by @gamemann!
https://github.com/bestmods/bestmods
createt3 mods next nextjs prisma react reactjs t3 tailwind tailwind-css tailwindcss trpc website
Last synced: 8 months ago
JSON representation
An open source website that allows users to browse mods in gaming from many sources on the Internet! Made by @gamemann!
- Host: GitHub
- URL: https://github.com/bestmods/bestmods
- Owner: bestmods
- License: gpl-3.0
- Created: 2022-12-11T23:24:55.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T01:03:03.000Z (over 1 year ago)
- Last Synced: 2025-01-30T22:41:56.194Z (over 1 year ago)
- Topics: createt3, mods, next, nextjs, prisma, react, reactjs, t3, tailwind, tailwind-css, tailwindcss, trpc, website
- Language: TypeScript
- Homepage: https://bestmods.io/
- Size: 57.8 MB
- Stars: 19
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# [Best Mods](https://bestmods.org)
Browse the best mods in gaming from many sources on the Internet!
## 2025 Update
While the website is still online, this project **is no longer maintained**! There is a chance I may overhaul the project at a later date, but I have no ETA since I have a lot of other work and projects to work on.
The website is still online as a part of my resume. There is also a lot of valuable code in this repository that I put many hours into making. With that said, I did a horrible job at the front-end design of the website in my opinion and that's something I'd really like to improve on if I do work on the project again. However, back-end wise I think there's a lot of neat functionality in the project.
If you're interested, I've also released the source code of the web scraper [here](https://github.com/bestmods/scan-r-us)!
## About This Project
An open source [website](https://bestmods.org) made by [Christian Deacon](https://github.com/gamemann) 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](https://bestmods.org/about)!
## Showcase
### Desktop
### Mobile
## Road Map
A road map for the website may be found [here](https://github.com/bestmods/bestmods/milestones)!
## Contributing
Any help from the open source community is highly appreciated on this project! We utilize the following.
* [Create T3 App](https://create.t3.gg/) (TypeScript).
* [Next.JS](https://nextjs.org/).
* [React](https://reactjs.org/).
* [tRPC](https://trpc.io/).
* [Prisma](https://www.prisma.io/).
* [Tailwind CSS](https://tailwindcss.com/).
Please take a look at our [road map](https://github.com/bestmods/roadmap/issues) and join our [Discord server](https://discord.moddingcommunity.com/) for communication!
## Our Community
[Best Mods](https://bestmods.org) is ran by [Christian Deacon](https://github.com/gamemann) and the [The Modding Community](https://moddingcommunity.com/). We have a Discord [here](https://discord.moddingcommunity.com/) if you want to socialize and interact with others including talented modders and content creators.
Additionally, you may also use our discussions forum [here](https://github.com/orgs/BestMods/discussions)!
### Social Media
* [TikTok](https://tiktok.com/@bestmodsio) (@bestmodsio)
* [Twitter](https://twitter.com/bestmodsio) (@bestmodsio)
* [Instagram](https://instagram.com/bestmodsio) (@bestmodsio)
* [Facebook](https://facebook.com/bestmodsio)
* [Linkedin](https://linkedin.com/company/bestmods)
* [Steam](https://steamcommunity.com/groups/best-mods)
* [Reddit](https://reddit.com/r/bestmods)
## 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"`.
1. In `prisma/schema.prisma`, remove all instances of `@db.Text` because PostgreSQL and SQLite have different column definitions for string.
1. 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.
```bash
# 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](https://bestmods.org/) 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
* [Christian Deacon](https://github.com/gamemann) - Creator
* [The Modding Community](https://github.com/modcommunity)