Skip to content

Latest commit

 

History

History
189 lines (145 loc) · 8.11 KB

README.md

File metadata and controls

189 lines (145 loc) · 8.11 KB
Raw


Logo

Modderize

A platform for creating and managing video game mod requests


View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Design Documentation
  4. Contact
  5. Acknowledgments

About The Project

Modderize website

Modderize is a web application for video game modders to track and fulfill feature requests from their communities; gamers can use it to make requests and discover new mod content. This application was built by Bianca Morris to fulfill the Capstone requirement of the Digital Media Design ALM Degree at Harvard Extension School.

(back to top)

Built With

  • Next @ 13.1.6
  • React @ 18.2.0
  • Tailwind @ 3.2.4
  • Firebase @ 9.16.0
  • Typescript @ 4.9.4

And deployed with Vercel.

(back to top)

Getting Started

To get a local copy up and running on your machine, follow these simple example steps. Note: This project was build on a Mac; Windows or Linux installations may be slightly different.

Prerequisites

There are a few dependencies that will not be installed as a result of the 'local installation' process below. These are as follows:

  • Download and install NodeJS at v18 (Can also use node version manager, of course.)
  • NPM comes installed (For reference: version v8.19.3 was used to build this.)

Local Installation

  1. Clone the repo and navigate to it 
    git clone https://github.com/bianca-morris/modderize.git
cd modderize
  2. Install NPM packages from package-lock.json 
    npm ci
  3. Create a copy of .env.local-template at the root of this repo; name it .env.local or .env.sh
  4. Set up a Google Firebase account and project (with Authentication, Firestore, and Cloud Storage); tutorial here.
  5. Enter the keys from your Firebase project into the .env.local file; save it. 
    export NEXT_PUBLIC_FIREBASE_API_KEY=<YOUR INFO HERE>
export NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=<YOUR INFO HERE>
export NEXT_PUBLIC_FIREBASE_PROJECT_ID=<YOUR INFO HERE>
export NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=<YOUR INFO HERE>
export NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=<YOUR INFO HERE>
export NEXT_PUBLIC_FIREBASE_APP_ID=<YOUR INFO HERE>
  6. Load the environment variables 
    source <path to your .env.local file>
  7. Start the dev server 
    npm run dev
  8. Go to localhost:3000

(back to top)

Design Documentation

This repository also includes some documentation of the design system/component library used to create this website.

Image from Gyazo

In order to access this documentation, set up the environment using the instructions in the local installation section above, and then follow the following steps:

  1. Ensure the most recent minified CSS bundle is built by running:
npm run minify
  1. Run storybook; it should open up in your browser automatically, but if it doesn't, it will run at localhost:6006.
npm run storybook

Note: Not every component used within the application is documented, however, the basic building blocks that do not require data from Firebase to function are mostly accounted for.

(back to top)

Contact

Bianca Morris - biancaallynm@protonmail.com

Project Link: https://github.com/bianca-morris/modderize

(back to top)

Acknowledgments

(back to top)