README.md

Project: Dispense 💡

Description

Google Developer Student Club project at William & Mary to build a vending machine for the Entrepreneurship Center.

Setup

1. Prerequisites

• Python v.3.11.*
• Node.js v.19.* Very important! You need the fetch library.

2. Download

Clone this repository to your computer

git clone https://github.com/jasonycin/project_dispense.git # Download files
cd project_dispense # Change into downloaded directory

3. Install Python dependencies

All of the required dependencies have been laid out in a requirements.txt file.

cd scripts
pip install -r requirements.txt

4. Setup server

This project uses the Ts.ED framework for the server which is built upon Node.js and utilizes TypeScript.

Install the Ts.ED CLI for easily adding tools and files to the project.

npm install -g @tsed/cli # You may need sudo privileges

Install required dependencies for the NPM project.

cd server
npm install # Installs dependencies

🚨 If you're missing the .env file, obtain permission and download it to the server directory. You will need to rename the file and add a . in the front❗️

npm start # Hope it works ✨!

Diagram