Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

61040-fa22/final-project-Team-Roomba

 
 

Repository files navigation

homepage

🎯OurSpace: discover, request, and contribute to spaces in your community!

6.1040 Software Studio

Final Project - Fall 2022

Quick Links

About the Project

Service issues happen daily across our campus, as well as the millions of shared spaces and facilities around the country. The current status quo of raising service requests individually to administrations works to identify singular problems, but doesn't really provide a domain to discover the unspoken shared desires of a community. Surveys can help uncover possible improvements and shortcomings for spaces, but often suffer from non-response and sampling bias, and rely on the initiative of the administrative body facilitating the survey.

Overview

🎯OurSpace enables crowdsourced service requests of communal spaces, and thus provides a domain where users can share their opinions and amplify their unspoken ideas- as well as discover new spaces within their community. 🎯OurSpace strives to serve as a tool to collect voices and ideas about the 90% of issues about community spaces that are often missed due to a lack of community platform.

Tech Stack

Here's a high-level overview of the tech stack 🎯OurSpace uses:
  • This project was developed in Vue 3 + TypeScript
  • For storage, the app uses Mongo DB, which serves all our needs with document-based databasing.
  • API routes uses OpenAPI Specification which allows easy defining of a standard, language-agnostic interface to our RESTful API.
  • For UI deployment, the app uses Vercel.

Useful IDE References

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev
npm run dev-api

dev-api will automatically reload the server when you make changes to the API server, and requests will be proxied through the Vite dev server.

View OpenAPI Docs

npm run dev-api
npm run docs

Then, open 127.0.0.1:8080, and you'll be able to browse and execute the OpenAPI endpoints.

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 60.1%
  • Vue 39.2%
  • Other 0.7%