Skip to content

unoacm/Website

Repository files navigation

UNO ACM Website

This repository holds all the source code for the UNO ACM Website. The only thing not here is the database file. Since this website will not have much activity, the database will be a sqlite file. This may need to change in the future.

Installation and Run Guide

The first thing you'll have to do is clone this repository.

git clone https://github.com/unoacm/Website.git

Since this website is using Python, it is recommended to use a virtual environment with this. The easiest way to set it up is to have a folder containing your virtual envrionment and whatever folder comes from the git clone, such as:

WebsiteProject
  |
  --- env (virtual environment)
  |
  --- Website (git clone)

Once you have made your virtual environment, you will want to activate it. Then you want to use pip to install all the requirements inside of the requirements.txt file:

pip install -r requirements.txt

After that you should be able to run it:

python website.py

or

py website.py

Production Run

Currently the application is running in a Debian instance on Google Cloud Platform. An installation guide will be posted here at some point.

To run the server:

source start.sh

Needed Environmental Variables

FLASK_ENV : 'development', 'production' : This tells flask whether the app is in development or production. In production a different database name/type will be used.

ACM_FLASK_ADMIN_USERNAME : anything : This will be used in creation of the default admin to sign in to the admin page.

ACM_FLASK_ADMIN_PASSWORD : anything : This will be used in creation of the default admin to sign in to the admin page.

ACM_FLASK_SECRET_KEY : anything : This is a key that Flask uses for security. Must be set when in production mode.

More installation instructions might appear as this application gets ready for production.

About

The Official UNO ACM Website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published