49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# smash
|
|
a bash.org clone built with Flask
|
|
|
|
## Technologies
|
|
- python
|
|
- Flask
|
|
- PostgreSQL
|
|
- SQLAlchemy
|
|
|
|
## Functionalities
|
|
- Quote database
|
|
- Tags for grouping and classifying quotes
|
|
- Moderation queue, admin approval required for adding new quotes
|
|
- Pagination
|
|
- Ratings
|
|
|
|
## How to run
|
|
This program is designed to be easy to deploy via Heroku. It can also run locally.
|
|
|
|
First, you have to edit the config file (`config.json`). `APPNAME` is the name that will be displayed in the title bar in the browser, while `APPBRAND` is the name that will be displayed in the navbar on every page.
|
|
|
|
`SECRETKEY` will be used to encrypt and sign session cookies, so it needs to be a cryptographically-secure random string. `ADMINSECRET` will be used to elevate privileges to allow approving and deleting new quotes. There are no user accounts since there are no user-specific functionalities.
|
|
|
|
`MOTD` will be displayed on the index page.
|
|
|
|
`APPNAME` and `APPBRAND` will be loaded from the environment if they're left empty in the config.
|
|
|
|
Smash uses PostgreSQL. Before you start, you need to set `DATABASE_URL` environment variable to a valid URL leading to your database. If you install the Heroku plugin, it will be done automatically for you - you only need to do this manually if you want to run Smash locally.
|
|
|
|
After basic config is done, run this to start the server:
|
|
|
|
```
|
|
python run.py
|
|
```
|
|
|
|
The program looks for `HEROKU` in the environment; if that variable is equal to 1, it interprets this as a sign that it's running in a production environment and starts in the externally visible mode with debug turned off. It also needs the `PORT` environment variable to have some sensible value; this is configured automatically when deploying on heroku.
|
|
|
|
The first time it's started it will create the local database and all required tables, as specified by models. After that it's ready to be used.
|
|
|
|
All logging is done by printing to stdout - heroku adds that to the app logs visible in the dashboard.
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|