Skip to content
James edited this page Mar 20, 2022 · 2 revisions

Welcome to the Updog wiki!

Updog is a social media application where users can share their thoughts and listen to others.

Technical Introduction

This is a monorepo containing both the frontend and backend. They share linting rules and style conventions enforced via prettier/eslint.

Stack

Frontend:

  • Javascript
  • React
  • Material UI

Backend:

  • Javascript
  • NodeJS
  • Sequelize (ORM)
  • Express

Quick Start

Run npm i in these directories:

  • /
  • /frontend
  • /backend

The project root contains the eslint rules and pre-commit hooks, so make sure you npm i at the root to enable these tools.

Then, follow the frontend readme and/or the backend readme to launch the apps.