README.md

don-efficace

Welcome to the don-efficace platform repository!

Stack Choices

Backend Language: TypeScript (Express.js on Node.js)
Backend API: REST
Database: PostgreSQL
User Auth: Yes
File Storage: Yes

Table of Contents

• 📝 Documentation
• 👷 Getting Started
  • ✔️ Prerequisites
  • ⚙️ Setup
• ✨ Linting & Formatting
• 💻 The Team

Documentation

Starter Code
Don Efficace Notion

Getting Started

Prerequisites

• Install Docker Desktop (MacOS | Windows (Home) | Windows (Pro, Enterprise, Education) | Linux) and ensure that it is running
• Ask the current PL to receive access to ENV Variables

Setup

1. Clone this repository and cd into the project folder

git clone https://github.com/uwblueprint/don-efficace.git
cd don-efficace

2. Ensure that environment variables have been added to the following directories:

/.env
/frontend/.env

3. Run the application

docker compose up --build

Linting & Formatting

Mac

docker exec -it scv2-backend /bin/bash -c "yarn fix"

docker exec -it scv2-frontend /bin/bash -c "yarn fix"

Windows

docker exec -it scv2-backend bash -c "yarn fix"

docker exec -it scv2-frontend bash -c "yarn fix"

Database/Prisma Information

Note: Manual Database Setup

If for some reason docker container is not syncing with your prisma models in backend/typescript/prisma/schema

Update .env file in /backend/typescript to be (Use different username for Mac)

DATABASE_URL=postgresql://postgres:postgres@localhost:5432/scv2

Try running (when the docker container is up):

npx prisma migrate dev

This may require you to upgrade your node version locally so try (only if it tells you the node version is insufficient) (https://www.freecodecamp.org/news/node-version-manager-nvm-install-guide/) If you don't have nvm

nvm install 18.18.2
nvm use 18.18.2

Creating Prisma Migration

Go to backend/typescript and run

npx prisma migrate dev

Useful Prisma Commands

"npx prisma db push" to push "npx prisma studio" to run prisma

Need to change scv2 to don-efficace at some point

The Team

Term 1 (W24):

Project Lead: N/A
Product Managers: Jacqueline Fung & Zafir Raeid
Developers: Jessica Ding, Nandini Mehrotra, Shushawn Saha
Designers: Hillary Heung, Sunny Zhang, David Stirling

Huge shoutout to the Internal Tools team for creating StarterCode v2!