Vectra
Boost your math skills with interactive activities and expert guidance on visualizing math shapes. Repo for Imagine Cup 2023
Install / Use
/learn @VTIvanov20/VectraREADME
<h1 align="center">Team Graphically Speaking</h1>
<p align = "center">
<img src="https://media.discordapp.net/attachments/1061363565644226720/1069726691724902591/banner.jpg?width=972&height=543" />
</p>
<p align = "center">
<img alt="GitHub license" src="https://img.shields.io/github/license/VTIvanov20/Vectra?style=for-the-badge">
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/VTIvanov20/Vectra?style=for-the-badge">
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/VTIvanov20/Vectra?style=for-the-badge">
<img src="https://img.shields.io/github/languages/count/VTIvanov20/Vectra?style=for-the-badge">
</p>
Backend is on
Frontend is on
<p align = "center">
<img src="https://media.discordapp.net/attachments/1061363565644226720/1069727102015897670/logo_text.png" />
</p>
<hr>
💻 About
<p align="center">We're making a platform that clarifies the need to make learning hard sciences like math more interactive and visual for students.</p>ℹ️ Detailed information
<p align="center"> The solution we propose is a platform that uses augmented reality (AR) technology to allow students to scan real-life objects using their mobile device's camera, separate the object into individual shapes, and access our website to add their photos to the drawing editor where they can get information about them. This allows students to better understand and visualize complex concepts and theories in a more interactive and engaging way.</p>🗂️ Tech Stack:
<p align="left"> <a href="https://code.visualstudio.com/"><img src="https://img.icons8.com/color/344/visual-studio-code-2019.png" alt="VS code logo" width=48px /></a> <a href="https://www.figma.com/"><img src="https://img.icons8.com/color/344/figma--v1.png" alt="Figma logo" width=48px/></a> <a href="https://github.com/"><img src="https://img.icons8.com/nolan/344/github.png" alt="GitHub logo" width=52px /></a> <a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5"><img src="https://img.icons8.com/color/344/html-5--v1.png" alt="HTML logo" width=48px /></a> <a href="https://developer.mozilla.org/en-US/docs/Web/CSS"><img src="https://img.icons8.com/color/344/css3.png" alt="CSS logo" width=48px /></a> <a href="https://sass-lang.com/"><img src="https://img.icons8.com/color/344/sass.png" alt="SASS logo" width=48px /></a> <a href="https://reactnative.dev/"><img src="https://img.icons8.com/color/344/react-native.png" alt="React Native logo" width=50px /></a> <a href="https://www.typescriptlang.org/"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/4/4c/Typescript_logo_2020.svg/2048px-Typescript_logo_2020.svg.png" alt="Typescript logo" width=50px /></a> <a href="https://chakra-ui.com/"><img src="https://archive.org/download/github.com-chakra-ui-chakra-ui_-_2020-02-13_17-20-29/cover.jpg" alt="Chakra logo" width=50px /></a> <a href="https://www.djangoproject.com/"><img src="https://framagit.org/uploads/-/system/project/avatar/28062/django.png" alt="Django logo" width=50px /></a> <a href="https://azure.microsoft.com/en-us/"><img src="https://img.icons8.com/fluency/344/azure-1.png" alt="Azure logo" width=48px /></a> <a href="https://azure.microsoft.com/en-us/products/postgresql/"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/2/29/Postgresql_elephant.svg/1200px-Postgresql_elephant.svg.png" alt="Azure logo" width=48px /></a> <a href="https://azure.microsoft.com/en-us/services/app-service/"><img src="https://ms-azuretools.gallerycdn.vsassets.io/extensions/ms-azuretools/vscode-azureappservice/0.23.3/1650585198428/Microsoft.VisualStudio.Services.Icons.Default" alt="Azure App Service logo" width=48px /></a> <a href="https://www.customvision.ai/"><img src="https://www.customvision.ai/Images/logo.svg" alt="Custom Vision logo" width=50px /></a> <a href="https://www.postman.com/"><img src="https://res.cloudinary.com/postman/image/upload/t_team_logo/v1629869194/team/2893aede23f01bfcbd2319326bc96a6ed0524eba759745ed6d73405a3a8b67a8" alt="Postman logo" width=54px /></a> </p>📄 Documents
Documentation:
Presentation:
User Manual
Project diagram:
📥 Installation & Set Up
<p> To install our project on your machine you just need to clone it. This can be done by following these steps! </p> <hr> <h3><B>Cloning the repository:</B></h3>Pasting this line of code in your favourite Terminal:
<pre>git clone https://github.com/VTIvanov20/Vectra.git</pre> <p>You have successfully cloned the repository! 🥳</p> <hr> <h3><B>Running the Web App:</B></h3> <ul> <li>You can paste this link in your URL bar of your preferred browser:</li> </ul> <pre>https://nice-smoke-0cc123703.2.azurestaticapps.net/</pre> <p>or...</p> <ul> <li>From the cloned project, go to the web folder and run it with the commands:</li> </ul> <pre>npm install npm run dev</pre> <p>You have successfully accessed our website! 👏👏👏</p> <p>If you are having any difficulties with the installation or set up, just let us know in the <a href="https://github.com/VTIvanov20/Vectra/discussions">Discussion</a> tab! 💬</p> <hr>Running the project
- Run backend and db containers
docker-compose up -d - Install frontend dependencies
make dev-install - Run frontend
make dev
