Egiraffe is a website to download and share exam papers and other study materials.
Since 2005, when the first version of Egiraffe was released, it has been used by thousands of students in Austria.
Now, in 2023, Egiraffe is being rewritten from scratch to provide a more modern and easier to use experience.
To see what needs to get done, check out the work packages in work_pkgs.md.
Assuming you installed all the tools (Node, Rust, pnpm, docker) just run:
cd frontend
pnpm i
pnpm build
cd ../backend
sudo docker compose up -d
export DATABASE_URL='postgresql://egiraffe:hunter2@localhost:5432/egiraffe?sslmode=disable'
cargo sqlx migrate run
cargo runYou might need to get the correct IP address by running sudo docker inspect egiraffe-ng-db-1 | grep '"IPAddress":'
See the requirements for a list of things needing to be done (detailed list).
To see a simple list of what needs to get done, check out the work packages in work_pkgs.md.
The project is structured in two parts: the frontend and the backend.
The frontend of Egiraffe is written in Solid.js and Tailwind CSS.
See its code in the frontend directory, and its README in frontend/README.md.
The backend of Egiraffe is written in Rust using the Axum framework.
See its code in the backend directory, and its README in backend/README.md.
Our SQL library sqlx utilizes optional macros (which we use) to check the SQL statements at compile time.
It needs a working connection to a db to do so, so be sure to start docker-compose before. e.g.:
# For example, this code starts the db, launches VS Code(ium), and exits the shell sudo docker-compose up -d && code ~/Repos/egiraffe-ng && exit
Update: these days, you can just tell rust-analyzer to restart, which seems to help.
You can create a Docker image with both the frontend and the backend using the Dockerfile in the root directory of the project.
# In the root directory of the project
docker build . -t egiraffethen run it with
docker run -it --rm --name egiraffe_dev egiraffe:latest
Egiraffe, "the software" (code, assets, design documents, and documentation) copyright (C) 2023 HTU Graz
Egiraffe is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
Egiraffe is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with Egiraffe. If not, see https://www.gnu.org/licenses/, specifically https://www.gnu.org/licenses/agpl-3.0.html.