Create a python environment
$python -m venv venv
Activate it
$source venv/bin/activate
Install Flask and other main dependencies:
$pip install -U flask flask-cors requests pybtex
Install bibtexparser (directly from git)
$pip install --no-cache-dir --force-reinstall git+https://github.com/sciunto-org/python-bibtexparser@main
Run the app locally:
$python __init__.py
You should now be able to see the log on your terminal and access the page on your localhost:
You can propose changes through pull requests (PR).
- Fork this repository (https://github.com/cltl/cltl-homepage). This will create a
cltl-homepage
repository (so-called fork) under your account. - Clone your fork to work locally.
$ git clone [email protected]:<YOUR_USERNAME>/cltl-homepage.git
- Add
cltl/cltl-homepage
as a remote repository to allow updates fromcltl/cltl-homepage
to your local copy
$ cd cltl-homepage
cltl-homepage$ git remote add upstream [email protected]:cltl/cltl-homepage.git
- Your local copy initially has a single branch, called
main
. Whenever you plan to make a commit, you should first make sure that yourmain
branch incorporates changes tocltl/cltl-homepage
:
cltl-homepage$ git pull upstream main
Update your fork's content by pushing the local changes
cltl-homepage$ git push -u origin main
- Always make changes in a separate branch, to prevent merge conflicts in your main branch. Create a new branch with a descriptive name, e.g.
update-current-news-page
:
$ git checkout -b new-feature
Your repository should now have two branches. You can check this by typing git branch
:
cltl-homepage$ git branch
main
* update-current-news-page
The asterisk marks the active branch
- You can now work and modify files in the repository.
- Deploy the website locally to test and verify your changes
- Stage and commit your changes, then push them to your repository:
cltl-homepage$ git add --all
cltl-homepage$ git commit -m "update current news page"
cltl-homepage$ git push -u origin update-current-news-page
This will create a branch update-current-news-page
in your fork. You can make a pull request from there
The goal of the pull request is to have the content of the branch update-current-news-page
in your fork pulled into the cltl/cltl-homepage
repository.
Follow these instructions to make the pull request, where head repository
points your fork, and base repository
points to cltl/cltl-homepage
.