The ultimate File Management System for (almost) all Tu/e courses
Markis is written in python using the Flask Micro-framework
follow these instructions if you want to setup a copy of the project on your local machine for development and testing purposes.
In order to setup the development environment you need to install the following:
firstly install Python 3.6, together with Pip.
then, in the root directory run pip install -r requirements.txt to install all dependencies.
After having installed the required packages you can run python app.py to run the server.
Configure /instance/config.py as you please. Your version of this file should not be in the repository.
You need to define the following variables in /instance/config.py in order to successfully run a development instance:
- Add a
SECRET_KEYvariable - Add information for a development database (email the project owners if you wish to use a hosted DB server)
SQLALCHEMY_DATABASE_URI. - Add the following:
DEBUG = True&SQLALCHEMY_ECHO = True(to overwrite main configuration) - Add your own url, username and password for a crowd REST server, you can ask the project owner for a hosted crowd server
The files and folders are divided as follows:
| File/Folder | description |
|---|---|
| run.py | This is the file that is invoked to start up a development server, it won't be used in production |
| requirements.txt | This file lists all of the Python packages needed to run this server, run pip install -r requirements.txt to install said packages |
| config.py | This file contains most of the configuration variables, as well as STATIC variables |
| /instance/config.py | This file contains additional/overwritten settings specific to one's development environment. Your version should not be pushed to version control |
| /Markis/ | The package of our app |
| /Markis/init.py | This file initializes your application and brings together all of the various components |
| /Markis/views.py | This is where the routes are defined |
| /Markis/util | This folder contains utility files |
| /Markis/models.py | This is where models are defined |
| /Markis/forms.py | This is where forms are defined |
| /Markis/static/ | This folder contains static files such as stylesheets and images |
| /Markis/templates/ | This folder contains Jinja2 templates |
| /Markis/static/filestore | This folder stores all the files uploaded to Markis. These should not be added to version control |
More folders may be added as needed.
Please see the list of contributors who participated in this project.
If you wish to implement a feature please first discuss your idea with the project owners before making an changes. All pull requests are to be reviewed by the project owners, who may suggest some changes or improvements or alternative. In order to increase the chance your pull request will be accepted:
- Only implement features we approve of, you can check this by sending us an email
- Write tests
- Follow the style guide
- Write proper commit messages: A (capitalised) max 50 char summary, followed by an optional max 72 char explanation. Always make your summary such that it finishes the sentence "If applied, this commit will ..." . Don't do this
- New web-pages always extend base templates unless there is a valid reason not to