{"id":26738373,"url":"https://github.com/ahmaruff/collegejournal","last_synced_at":"2026-04-28T11:34:24.487Z","repository":{"id":172164892,"uuid":"289292979","full_name":"ahmaruff/collegejournal","owner":"ahmaruff","description":"simple college journal-entries app, made with flask.","archived":false,"fork":false,"pushed_at":"2020-08-31T13:35:06.000Z","size":64,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T03:30:49.488Z","etag":null,"topics":["flask","python"],"latest_commit_sha":null,"homepage":"https://ahmaruff.pythonanywhere.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ahmaruff.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2020-08-21T14:44:48.000Z","updated_at":"2021-01-05T00:46:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"87474b9f-ffb3-4815-8e59-1c3eadb87f4d","html_url":"https://github.com/ahmaruff/collegejournal","commit_stats":null,"previous_names":["ahmaruff/collegejournal"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ahmaruff/collegejournal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmaruff%2Fcollegejournal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmaruff%2Fcollegejournal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmaruff%2Fcollegejournal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmaruff%2Fcollegejournal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmaruff","download_url":"https://codeload.github.com/ahmaruff/collegejournal/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmaruff%2Fcollegejournal/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32379414,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-28T11:25:28.583Z","status":"ssl_error","status_checked_at":"2026-04-28T11:25:05.435Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["flask","python"],"created_at":"2025-03-28T03:29:14.056Z","updated_at":"2026-04-28T11:34:24.467Z","avatar_url":"https://github.com/ahmaruff.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# College Journal\na simple college-journal entries app, made with flask.\n\n\n## Getting Started\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.\n\n### Prerequisites\n1. Python 3.8 or later\n2. Text Editor (VS-Code/Pycharm/Sublime/etc)\n3. Git\n\n### Instalation\n1. Install all prerequisites app above\n2. Clone this project to your local machine. [how to](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)\n3. create new venv (virtual environment) inside this project directory on your local machine. [how to](https://docs.python.org/3/library/venv.html)\n4. Download \u0026 install required library in requirements.txt  \n  a. Open terminal  \n  b. Activate your venv,[how to](https://docs.python.org/3/library/venv.html)  \n  c. go to your working directory (this project directory) and run this command    \n    \n    ```\n    for windows :  \n    $ python -m pip install -r requirements.txt\n    \n    for Linux :\n    $ pip install -r requirements.txt\n    ```\n\n## Initial Configuration\n\n### Database Setup\n1. open `config.py`  \nchange Database URI to Correct `DATABASE_URI` that you want to use. Especially on `DevelopmentConfig` (since you are using this project for development purpose.)\ntake a look to [this page](https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/) for more information.\n\n  ```\n  import os\n\n  basedir = os.path.abspath(os.path.dirname(__file__))\n  ####\n  \n  class DevelopmentConfig(Config):\n    DEBUG = True\n    SQLALCHEMY_DATABASE_URI = os.environ.get('DEV_DATABASE_URL') or \\\n          # pick one database URI that you want to use. (sometimes you need some other external library,  this is depends on your setup)\n          'mysql://username:password@localhost/yourdatabase'\n          'postgresql://usernamepasswordr@localhost/mydatabase'\n          'oracle://username:pasword@127.0.0.1:1521/sidname'\n          'sqlite:///' + os.path.join(basedir, 'data-dev.sqlite')\n   ```\n   \n   \n### Create Database Table  \n  a. open terminal, move to working directory, and activate your venv.  \n  b. setup environment variable so flask can run,\n\n  ```\n  on Linux:\n  $ export FLASK_APP=run.py\n  $ export FLASK_CONFIG='development'\n  \n  on Windows CMD:\n  $ set FLASK_APP='run.py'\n  $ set FLASK_CONFIG='development'\n  \n  on Windows Powershell:\n  $ $env:FLASK_APP='run.py'\n  $ $env:FLASK_CONFIG='development'\n\n  ```  \n  \n  c. run `flask shell` on your terminal, (note the terminal icon change from `$` to `\u003e\u003e\u003e`)  \n  d. run this command:\n  \n  ```\n    from run import db (click enter)\n    \n    db.create_all() (click enter)\n    \n    quit() (click enter to quit shell)\n  ```\n\n## Start Your Flask App\n  1. open terminal, move to working directory, and activate your venv.\n  2. setup environment variable so flask can run,\n  \n  ```\n  on Linux:\n  $ export FLASK_APP=run.py\n  $ export FLASK_CONFIG='development'\n  $ export MAIL_USERNAME='youraccount@gmail.com'\n  $ export MAIL_PASSWORD='your-gmail-password'\n  \n  on Windows CMD:\n  $ set FLASK_APP='run.py'\n  $ set FLASK_CONFIG='development'\n  $ set MAIL_USERNAME='youraccount@gmail.com'\n  $ set MAIL_PASSWORD='your-gmail-password'\n  \n  on Windows Powershell:\n  $ $env:FLASK_APP='run.py'\n  $ $env:FLASK_CONFIG='development'\n  $ $env:MAIL_USERNAME='youraccount@gmail.com'\n  $ $env:MAIL_PASSWORD='your-gmail-password'\n  ```\n  \n  3. run this command on your terminal\n    `flask run`\n  \n  4. if there's no problem, your terminal will show your web information and Debugging information. you web will run on localhost or 127.0.0.1 and use port number 5000\n  \n  5. try open browser and access `http://localhost:5000`\n          \n## Production Deployment  \nThese are reference link about how to deploy this app into [pythonanywhere](https://pythonanywhere.com)  \n- [how to deploy existing django app to pythonanywhere](https://help.pythonanywhere.com/pages/DeployExistingDjangoProject/)  \n- [setting up flask application on pythonanywhere](https://help.pythonanywhere.com/pages/Flask/)  \n\nPlease refer to [this page](https://help.pythonanywhere.com/pages/environment-variables-for-web-apps/) to setup `environment variable`  \n\n### Database Setup on Pythonanywhere\n1. Create new database from database menu on Pythonanywhere dashboard.\n2. declare your database to `config.py`, especially on `ProductionConfig`\n  ```\n  `mysql+mysqldb://username:password@database-host-address/yourdatabase`\n  \n  in pythonanywhere its often looks like this:  \n  `mysql+mysqldb://yourusername:databasepassword@yourusername.mysql.pythonanywhere-services.com/yourusername$database'\n  ```\n3. **Create Database Tables**  \n  a. open bash console from pythonanywhere dashboard.  \n  b. activate you venv  \n     `workon your-venv`  \n  c. move to project directory  \n    `cd myproject`  \n    d. run `flask shell` on your terminal, (note the terminal icon change from $ to \u003e\u003e\u003e)  \n    e. run this command    \n    ```\n    from run import db\n    db.create_all()\n    ```  \n    f. your database ready to use\n  \n\u003e There's no big different on configuring for Production and Development. you just need to take more attention on Database Connection and ofcourse, **Security**  \n\n## Build With\n- [Python](https://www.python.org) -Programing Language that used.\n- [Flask](https://flask.palletsprojects.com/en/1.1.x/) -Web Framework that used\n\n## Todo  \n- testcase\n- admin-interface\n- documentation  \n\n## Author\n- [Ahmad Ma'ruf](https://github.com/ahmaruff)  \n           \n           \n           \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmaruff%2Fcollegejournal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmaruff%2Fcollegejournal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmaruff%2Fcollegejournal/lists"}