{"id":19533623,"url":"https://github.com/tigerappsorg/tigerpath","last_synced_at":"2025-04-26T13:33:50.124Z","repository":{"id":34102221,"uuid":"125558109","full_name":"TigerAppsOrg/TigerPath","owner":"TigerAppsOrg","description":"Four-year course planner for Princeton University students","archived":false,"fork":false,"pushed_at":"2024-04-06T03:24:21.000Z","size":7450,"stargazers_count":16,"open_issues_count":92,"forks_count":5,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-01T13:21:16.021Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://tigerpath.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TigerAppsOrg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-03-16T18:59:41.000Z","updated_at":"2023-02-22T00:41:14.000Z","dependencies_parsed_at":"2024-03-20T23:48:30.239Z","dependency_job_id":null,"html_url":"https://github.com/TigerAppsOrg/TigerPath","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TigerAppsOrg%2FTigerPath","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TigerAppsOrg%2FTigerPath/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TigerAppsOrg%2FTigerPath/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TigerAppsOrg%2FTigerPath/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TigerAppsOrg","download_url":"https://codeload.github.com/TigerAppsOrg/TigerPath/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224036300,"owners_count":17245035,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T02:08:53.198Z","updated_at":"2024-11-11T02:08:54.365Z","avatar_url":"https://github.com/TigerAppsOrg.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TigerPath\n\nTigerPath is a web app that helps Princeton University students plan out their four-year course schedules. It began as a COS 333 project by Richard Chu, Barak Nehoran, Adeniji Ogunlana, and Daniel Leung.\n\nYou can visit TigerPath at [tigerpath.io](https://www.tigerpath.io).\n\nTo learn about contributing to TigerPath, take a look at the [contributing guidelines](https://github.com/PrincetonUSG/TigerPath/blob/master/CONTRIBUTING.md).\n\n# Running locally\n\n## Initial setup\n\n### Python environment\n\n1. Create a new conda environment: `conda create -n tigerpath`\n1. Activate the conda environment: `conda activate tigerpath`\n1. Install python: `conda install python=3.9`\n1. Clone this repo and `cd` into the base TigerPath directory\n1. Install dependencies: `pip install -r requirements.txt`\n   - If you're running into a `psycopg2` error (`pg_config executable not found`), you probably have to install `postgresql`: https://stackoverflow.com/a/24645416\n1. Run `conda list` to validate that all packages in `requirements.txt` were installed\n1. Set all environment variables:\n   - Login to Heroku and go to the Settings tab for the `tigerpath333-dev` app (do NOT use prod!)\n   - Reveal Config Vars\n   - For each Config Var key-value pair, create a local environment variable: `conda env config vars set key=value` (replace `key` and `value` with the actual key and value)\n   - After setting all env vars, reactivate your conda environment: `conda activate tigerpath`\n   - Note that for `SECRET_KEY`, you might get an error so you can set its value to `1`\n1. Run `conda env config vars list` to validate all env vars were set\n\n### Node packages\n\n1. Run `cd frontend \u0026\u0026 npm install` to install all required frontend packages\n   - You might have to install `node` if you haven't already: https://formulae.brew.sh/formula/node\n\n## Running the dev server\n\nAfter following the initial setup steps above, you can run the local development server:\n\n1. Activate your environment: `conda activate tigerpath`\n1. Run the backend server: `python manage.py runserver`\n1. Run the frontend server in a separate terminal window: `cd frontend \u0026\u0026 npm start`\n   - Visit `http://localhost:8000/` to verify the server is up and running\n\n# Other important things\n\n#### Make migrations and update database\n\nYou can do this by running the following commands:\n\n```\npython manage.py makemigrations                             # Makes migrations based on models.py\npython manage.py migrate                                    # Migrates the database\n```\n\n#### Custom django-admin commands\n\n```\npython manage.py tigerpath_get_courses                      # Scrapes courses and puts them in the database\n```\n\n#### Load static data\n\nTo load the major mappings fixture, which populates the major table in the database, run the following command:\n\n```\npython manage.py loaddata major_mappings\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftigerappsorg%2Ftigerpath","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftigerappsorg%2Ftigerpath","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftigerappsorg%2Ftigerpath/lists"}