Skip to content

Latest commit

 

History

History
73 lines (60 loc) · 3.82 KB

README.md

File metadata and controls

73 lines (60 loc) · 3.82 KB
Raw

T-Eggletop Map Creator

UCLA 22W CS 35L project for team Eggmacs (Joice, Jordan, Kay, Meghana, Sean).

Introduction

This project is an implementation of the T-Eggletop Map Creator (TeMC), a webtool that allows the user to create their own maps for tabletop role-playing games (TTRPGs)! By creating a profile, users can create their own maps in the "Creator" tab, search for other users or their creations in the "Search" tab, and access their own user profile and map catalog in the "Profile" tab.

You can use TeMC here!
(Direct link for those who despise hyperlinks: https://eggmacs.herokuapp.com)
Update: Heroku free tier is down. We are working on moving TeMC to somewhere else!

Running TeMC

In order to run TeMC, you need to add a config.env file to the /server/ folder. If you are a TA for CS35L (for which this project was created!), please email one of the team members for the contents of this file! In order to run the app, please follow these steps (assuming that Node.js is already installed on your machine):

  1. Clone this repository;
  2. Create a file named config.env inside the /server/ directory and fill it with the necessary MongoDB URI information;
  3. From the root directory of the project, run npm run dev.

Doing so will set up the required node modules for TeMC, and run both the client and server concurrently, launching the webapp in your browser under localhost:3000 and the server under localhost:5000!

Design & Implementation

TeMC is created using React and Node.js, with a backend database that utilizes MongoDB. All of our visual assets were created by Joice !

Frontend

A large portion of TeMC is the frontend code, implemented within /client/src . Within this, the code is organized into components, methods, and pages.

Components

Components are modules that include visual React components, such as the templates for forms (e.g., profile updates) and templates for the search results. This is to provide visual clarity in the React implementation and simplify the creation of the website visuals.

Methods

Methods are the 'connecting routines' for the website; these are what the frontend uses to connect with the backend code, and ultimately fetch data from MongoDB.

Pages

Pages are the visualization of each individual component of TeMC. These are implemented using methods and components, along with supplemental code. If App.js is the heart of the website, these are the limbs, with each website page being divided into its own file here!

Backend

Located within /server/routes, the backend of TeMC is what connects the websiteto our remote database! In order to simplify implementation and the expansion of features, every item within our database can be described as an Object. Many objects share characteristics, such as an _id: because many of the Objects share qualities, algorithms such as those in the search and fetch routines are able to handle a variety of components (e.g, users, maps, and visual assets)

Team Info

Joice: CSS, art & design, map item display
Jordan: Full-stack, user authentication, database API, map structure
Kay: Backend, search API, map download
Meghana: Map creator, interface
Sean: Operations, deployment, search/profile features

README written by the-bay-kay!