Loading README.md +37 −3 Original line number Diff line number Diff line Loading @@ -31,8 +31,42 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o See the [Contributing Guide](./CONTRIBUTING.md) for more details on how to contribute. ---- ## Run Portal locally If you are a rather visual learner, we also got you covered: Install necessary dependencies:  * [Git](https://git-scm.com/) * [uv](https://docs.astral.sh/uv/#installation) On the pool computers, Git is already installed, and uv can be installed with: ```sh curl -LsSf https://astral.sh/uv/install.sh | sh source $HOME/.local/bin/env ``` Then, clone the repository. You can do this using the Git integration of VS Code, or via the terminal: ```sh git clone https://gitlab.cl.uni-heidelberg.de/Fachschaft/portal.git ``` Then, run: ```sh cd portal export FLASK_APP=portal uv run alembic upgrade head # to create (and update!) the database uv run flask run ``` You can now access Portal at https://localhost:5000 > [!note] > After pulling changes from the repository, please run: > > ``` > uv run alembic upgrade head > ``` > > This is because the database schema might have changed online. Your local database must be upgraded to the latest schema to run the latest code. Loading
README.md +37 −3 Original line number Diff line number Diff line Loading @@ -31,8 +31,42 @@ Aren't you tired of having to remember shortlinks or URLs for all the services o See the [Contributing Guide](./CONTRIBUTING.md) for more details on how to contribute. ---- ## Run Portal locally If you are a rather visual learner, we also got you covered: Install necessary dependencies:  * [Git](https://git-scm.com/) * [uv](https://docs.astral.sh/uv/#installation) On the pool computers, Git is already installed, and uv can be installed with: ```sh curl -LsSf https://astral.sh/uv/install.sh | sh source $HOME/.local/bin/env ``` Then, clone the repository. You can do this using the Git integration of VS Code, or via the terminal: ```sh git clone https://gitlab.cl.uni-heidelberg.de/Fachschaft/portal.git ``` Then, run: ```sh cd portal export FLASK_APP=portal uv run alembic upgrade head # to create (and update!) the database uv run flask run ``` You can now access Portal at https://localhost:5000 > [!note] > After pulling changes from the repository, please run: > > ``` > uv run alembic upgrade head > ``` > > This is because the database schema might have changed online. Your local database must be upgraded to the latest schema to run the latest code.
