https://github.com/ahmaruff/collegejournal
simple college journal-entries app, made with flask.
https://github.com/ahmaruff/collegejournal
flask python
Last synced: 2 months ago
JSON representation
simple college journal-entries app, made with flask.
- Host: GitHub
- URL: https://github.com/ahmaruff/collegejournal
- Owner: ahmaruff
- Created: 2020-08-21T14:44:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-08-31T13:35:06.000Z (almost 6 years ago)
- Last Synced: 2025-03-28T03:30:49.488Z (over 1 year ago)
- Topics: flask, python
- Language: Python
- Homepage: https://ahmaruff.pythonanywhere.com
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# College Journal
a simple college-journal entries app, made with flask.
## Getting Started
These 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.
### Prerequisites
1. Python 3.8 or later
2. Text Editor (VS-Code/Pycharm/Sublime/etc)
3. Git
### Instalation
1. Install all prerequisites app above
2. Clone this project to your local machine. [how to](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
3. create new venv (virtual environment) inside this project directory on your local machine. [how to](https://docs.python.org/3/library/venv.html)
4. Download & install required library in requirements.txt
a. Open terminal
b. Activate your venv,[how to](https://docs.python.org/3/library/venv.html)
c. go to your working directory (this project directory) and run this command
```
for windows :
$ python -m pip install -r requirements.txt
for Linux :
$ pip install -r requirements.txt
```
## Initial Configuration
### Database Setup
1. open `config.py`
change Database URI to Correct `DATABASE_URI` that you want to use. Especially on `DevelopmentConfig` (since you are using this project for development purpose.)
take a look to [this page](https://flask-sqlalchemy.palletsprojects.com/en/2.x/config/) for more information.
```
import os
basedir = os.path.abspath(os.path.dirname(__file__))
####
class DevelopmentConfig(Config):
DEBUG = True
SQLALCHEMY_DATABASE_URI = os.environ.get('DEV_DATABASE_URL') or \
# pick one database URI that you want to use. (sometimes you need some other external library, this is depends on your setup)
'mysql://username:password@localhost/yourdatabase'
'postgresql://usernamepasswordr@localhost/mydatabase'
'oracle://username:pasword@127.0.0.1:1521/sidname'
'sqlite:///' + os.path.join(basedir, 'data-dev.sqlite')
```
### Create Database Table
a. open terminal, move to working directory, and activate your venv.
b. setup environment variable so flask can run,
```
on Linux:
$ export FLASK_APP=run.py
$ export FLASK_CONFIG='development'
on Windows CMD:
$ set FLASK_APP='run.py'
$ set FLASK_CONFIG='development'
on Windows Powershell:
$ $env:FLASK_APP='run.py'
$ $env:FLASK_CONFIG='development'
```
c. run `flask shell` on your terminal, (note the terminal icon change from `$` to `>>>`)
d. run this command:
```
from run import db (click enter)
db.create_all() (click enter)
quit() (click enter to quit shell)
```
## Start Your Flask App
1. open terminal, move to working directory, and activate your venv.
2. setup environment variable so flask can run,
```
on Linux:
$ export FLASK_APP=run.py
$ export FLASK_CONFIG='development'
$ export MAIL_USERNAME='youraccount@gmail.com'
$ export MAIL_PASSWORD='your-gmail-password'
on Windows CMD:
$ set FLASK_APP='run.py'
$ set FLASK_CONFIG='development'
$ set MAIL_USERNAME='youraccount@gmail.com'
$ set MAIL_PASSWORD='your-gmail-password'
on Windows Powershell:
$ $env:FLASK_APP='run.py'
$ $env:FLASK_CONFIG='development'
$ $env:MAIL_USERNAME='youraccount@gmail.com'
$ $env:MAIL_PASSWORD='your-gmail-password'
```
3. run this command on your terminal
`flask run`
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
5. try open browser and access `http://localhost:5000`
## Production Deployment
These are reference link about how to deploy this app into [pythonanywhere](https://pythonanywhere.com)
- [how to deploy existing django app to pythonanywhere](https://help.pythonanywhere.com/pages/DeployExistingDjangoProject/)
- [setting up flask application on pythonanywhere](https://help.pythonanywhere.com/pages/Flask/)
Please refer to [this page](https://help.pythonanywhere.com/pages/environment-variables-for-web-apps/) to setup `environment variable`
### Database Setup on Pythonanywhere
1. Create new database from database menu on Pythonanywhere dashboard.
2. declare your database to `config.py`, especially on `ProductionConfig`
```
`mysql+mysqldb://username:password@database-host-address/yourdatabase`
in pythonanywhere its often looks like this:
`mysql+mysqldb://yourusername:databasepassword@yourusername.mysql.pythonanywhere-services.com/yourusername$database'
```
3. **Create Database Tables**
a. open bash console from pythonanywhere dashboard.
b. activate you venv
`workon your-venv`
c. move to project directory
`cd myproject`
d. run `flask shell` on your terminal, (note the terminal icon change from $ to >>>)
e. run this command
```
from run import db
db.create_all()
```
f. your database ready to use
> There's no big different on configuring for Production and Development. you just need to take more attention on Database Connection and ofcourse, **Security**
## Build With
- [Python](https://www.python.org) -Programing Language that used.
- [Flask](https://flask.palletsprojects.com/en/1.1.x/) -Web Framework that used
## Todo
- testcase
- admin-interface
- documentation
## Author
- [Ahmad Ma'ruf](https://github.com/ahmaruff)