Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 1.5 KB

README.md

File metadata and controls

48 lines (38 loc) · 1.5 KB

Modular Documents

A modular document creation system

Modular Documents Logo

To view in your browser, go to this website: Modular Documents

Steps to run the app locally

To run this locally, navigate to the directory you wish to download this into on your terminal, and run this:

git clone https://github.com/rtjoa/modular-documents.git

Once you've done that, run the following command:

cd modular-documents

Now run this to install all the dependencies needed:

npm install

Then run the following to open the website on localhost 3000

npm start

This should redirect you to the page in your browser.
If it doesn't, go to the following website

localhost:3000/

Tech Stack

We used a React frontend to communicate with Firebase for backend. A Firestore database stores the data of the individual documents as well as other meta information about the documents such as the document owner. We also make use of the Firebase storage to store images that users upload, so that they are retrievable after leaving the page.

Creators

Nareh Agazaryan
Advaith Gowrishetty
Austin Law
Ryan Tjoa
Conway Xu