PlanIt

A course discovery tool by ECE444 Group 10 - 4Sight

Website: ece444-planit.herokuapp.com

Table of Contents

1. Project Purpose
2. Version
3. Tech Stack
4. Development Environment
5. License
6. Contributing
7. Resources

Project Purpose

This is an ECE444 group project where our team of five is tasked with creating a course discovery tool. The tool is based off of and meant to be an improvement of Education Pathways. The repository for Education Pathways can be found here.

Version

v1.0.0

Tech Stack

Frontend:

• React.js
• Material UI

Backend:

• Flask
• SQLAlchemy

Database:

• PostgreSQL

Development Environment

More information can be found in the Wiki.

1. Download and install docker-compose

2. From the project directory, run docker-compose -f docker-compose.yml up -d --build

3. The App should be up at localhost:3000 and you can see the logs with docker logs --follow planit_app

4. The API should be up at localhost:5000 and you can see the logs with docker logs --follow planit_api

Testing:

For now, you can test the api using docker with the following steps:

1. After building the api from step 2 (or using docker-compose -f docker-compose.yml up -d --build)

2. Run docker exec -i planit_api python -m pytest api -W ignore::DeprecationWarning and the tests should run

License

MIT License

Contributing

See Contribution.md

Contributors

• Yousif Al-Furaiji
• Peter Maksymowsky
• Alan (Jia Bao) Du
• Yuhang Yan
• Kieun Joshua Park

Resources

Figma Designs

Github Projects Board

Github Wiki

Milestone Documentation (invite-only)