https://github.com/aaronjai/cits3403_project
Agile Web Development University Project - Environmental Impact Tracker
https://github.com/aaronjai/cits3403_project
flask flask-migrate flask-sqlalchemy flask-wtforms tailwindcss
Last synced: about 2 months ago
JSON representation
Agile Web Development University Project - Environmental Impact Tracker
- Host: GitHub
- URL: https://github.com/aaronjai/cits3403_project
- Owner: AaronJai
- Created: 2025-04-03T03:53:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-16T08:11:09.000Z (about 1 year ago)
- Last Synced: 2025-06-24T15:44:12.580Z (about 1 year ago)
- Topics: flask, flask-migrate, flask-sqlalchemy, flask-wtforms, tailwindcss
- Language: Python
- Homepage:
- Size: 12.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CITS3403 Project: EcoTrack
## Description
EcoTrack is an environmental impact tracker that allows users to monitor, analyse, and reduce their carbon footprint. Users can log their activities across categories such as energy consumption, transportation, food, and shopping. The app calculates a personalised snapshot of their emissions, compares them to national averages, and visualises progress toward sustainability goals. EcoTrack provides actionable insights, tailored suggestions, and live environmental news to help users make informed, eco-friendly choices and track their journey toward a lower-impact lifestyle.
## Tech Stack
- HTML
- CSS
- JavaScript
- TailwindCSS
- JQuery
- Flask
- AJAX/Websockets
- SQLite interfaced to via the SQLAlchemy package
## Members
| UWA ID | Name | GitHub Username |
| -------- | ---------------- | --------------------------------------------- |
| 23861827 | Mei Lin Ke | [MeiLin99999, Linda](https://github.com/MeiLin99999) |
| 23683717 | Salman Nikakhter | [samlam691](https://github.com/samlam691) |
| 23074324 | Hazel Wang | [useri4l](https://github.com/useri4l) |
| 22884212 | Aaron Tan | [AaronJai](https://github.com/AaronJai) |
## Setup Instructions
Follow these steps to set up the EcoTrack application:
1. **Clone the repository:**
```
git clone
cd CITS3403_PROJECT
```
2. **Create and activate a virtual environment:**
```
# Windows
python -m venv .venv
.venv\Scripts\activate
# Mac/Linux
python3 -m venv .venv
source .venv/bin/activate
```
3. **Install dependencies:**
```
pip install -r requirements.txt
```
- _Note: You may need to use ```pip3``` or a different command depending on how Python is installed on your system._
4. **Configure Environment variables**
Set up a new file named ```.env``` in the root directory of the project and add the following content:
```bash
FLASK_SECRET_KEY= # important
MAIL_SERVER=smtp.example.com # important
MAIL_PORT=587
MAIL_USE_TLS=true
MAIL_USERNAME= # important
MAIL_PASSWORD= # important
MAIL_DEFAULT_SENDER=EcoTrack
```
For security, you can create an "App Password" with your mail provider rather than using your real password.
After succesful setup, your ```.env``` file may look like:
```bash
FLASK_SECRET_KEY=i_love_matcha
MAIL_SERVER=smtp.gmail.com
MAIL_PORT=587
MAIL_USE_TLS=true
MAIL_USERNAME=test.example1@gmail.com
MAIL_PASSWORD=abcd efgh hijk lmno
MAIL_DEFAULT_SENDER=EcoTrack
```
Useful links for information on setting up app passwords:
- [Gmail](https://support.google.com/accounts/answer/185833?hl=en)
- [Outlook](https://support.microsoft.com/en-au/account-billing/how-to-get-and-use-app-passwords-5896ed9b-4263-e681-128a-a6f2979a7944)
- [Yahoo](https://help.yahoo.com/kb/SLN15241.html?guccounter=1&guce_referrer=aHR0cHM6Ly93d3cuZ29vZ2xlLmNvbS8&guce_referrer_sig=AQAAACM6bF-WHqshDR69KZBDLQXCaURxkoojDvEOdpxqmLNu-VsfTnqC2d8In7b1vGPgnT_v_3-fEPBZ1ZSmboFUxD1K8g88dhKGp1vcoDlnPtWLzTKu9IkAOQ2dd6s802EEOEhZHSSwQxW7bcIWU5ycr3HeO5KsT7WqYJiLHFHgzEN6)
- [Apple](https://support.apple.com/en-au/102654)
5. **Initialise the database:**
```
flask db upgrade
```
6. **Run the application:**
```
flask run
or, to open in debug mode:
python EcoTrack.py
```
- _Note: You may need to use ```python3``` or a different command depending on how Python is installed on your system._
7. **Access the application:**
Open a web browser and go to `http://127.0.0.1:5000/`
## Testing (from root directory)
```bash
# Unittest
python -m unittest tests/unit.py
# Selenium
python -m unittest tests.test_selenium
```
- You can add '-v' to the end for verbose outputs.
- For more detail on testing please see the ```README.md``` in the ```tests``` folder. Link [here](tests/README.md)
## Database Management
If you need to make changes to the database models:
1. Update the models in `app/models.py`
2. Run migrations:
```
flask db migrate -m "Description of changes"
flask db upgrade
```
To check database version history:
```
flask db history
```
To downgrade to a previous version:
```
flask db downgrade
```
## Styling - TailwindCSS
1. Install Tailwind CSS
```bash
npm install tailwindcss @tailwindcss/cli
```
2. Run the CLI tool to scan your source files for classes and build your CSS.
```bash
npx @tailwindcss/cli -i ./app/static/css/styles.css -o ./app/static/css/output.css --watch
```
- we ADD our classes to `styles.css`, but we link the `output.css` stylesheet
- CLI automatically rebuilds `output.css` whenever we add styles to `styles.css` (happens because of the --watch flag)
- if you accidentally cancel or close it, just re-run it
In case you get Permission denied on Mac, run:
```bash
chmod +x ./node_modules/.bin/tailwindcss
```
**Note:** For development, it is recommended to have two terminals open:
1. One for running the Flask server.
2. One for running the Tailwind CLI.
## Development
- The application uses SQLite for development
- Database file is stored in `app/app.db`
- Use `flask shell` to interact directly with the database