-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add readme, update exercise presentations
- Loading branch information
Showing
6 changed files
with
256 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: PR check build | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
workflow_dispatch: | ||
|
||
defaults: | ||
run: | ||
shell: bash | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
env: | ||
HUGO_VERSION: 0.143.1 | ||
steps: | ||
- name: Install Hugo | ||
run: | | ||
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \ | ||
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
submodules: recursive | ||
fetch-depth: '0' | ||
- name: Install Node.js dependencies | ||
run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true" | ||
- name: Hugo Build | ||
env: | ||
HUGO_CACHEDIR: ${{ runner.temp }}/hugo_cache | ||
HUGO_ENVIRONMENT: production | ||
TZ: Europe/Bratislava | ||
run: | | ||
hugo \ | ||
--gc \ | ||
--minify |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
# How to contribute | ||
|
||
Thank you for your interest in contributing to the course website for "Dátové štruktúry a algoritmy". We welcome | ||
contributions that help improve the website’s content, functionality, and design. By participating in this project, you | ||
agree to follow our guidelines, which ensure a welcoming and productive environment for everyone. | ||
|
||
## Ways you can contribute | ||
|
||
First, make sure you've read the [code of conduct](CODE_OF_CONDUCT.md). TL;DR: be excellent to each other. Be calm, be | ||
kind, help make engine a community where new faces feel welcome and old hands feel appreciated. | ||
|
||
* Report a bug. If you've found something that does not work or does not make sense, let us know. | ||
* Suggest a new feature. | ||
|
||
### How to Contribute | ||
|
||
Contributions can range from fixing typos and improving documentation to adding new course materials or enhancing the | ||
site’s layout. Here’s how to get started: | ||
|
||
1. **Fork the Repository:** Create your own copy of the repository on GitHub. | ||
2. **Clone Your Fork:** | ||
```bash | ||
git clone https://github.com/interes-group/PEVS-DSA-BIAX10031.git | ||
cd PEVS-DSA-BIAX10031 | ||
``` | ||
3. **Create a Branch:** | ||
Create a branch with issue id that solves the issue's problem or implements a suggestion. | ||
```bash | ||
git checkout -b issue/<issue id> | ||
``` | ||
4. **Make Your Changes:** | ||
Update the code, documentation, or content as needed. | ||
5. **Test Your Changes:** | ||
For content and layout changes, you can run the local Hugo server to preview your work: | ||
```bash | ||
hugo server -D | ||
``` | ||
6. **Commit and Push:** | ||
Commit your changes with clear, concise messages and push your branch: | ||
```bash | ||
git commit -m "[ISSUE ID] Brief description of your changes" | ||
git push origin feature/your-feature-name | ||
``` | ||
7. **Open a Pull Request:** | ||
Submit a pull request (PR) against the `main` branch of this repository. Please describe your changes and why they’re | ||
beneficial in the PR description. | ||
|
||
### Reporting bugs | ||
|
||
If you've found a bug, let us know about it. | ||
|
||
* Search the [Issues](https://github.com/interes-group/PEVS-DSA-BIAX10031/issues) to check we're not already tracking it. | ||
* If you can't find an open issue that describes your | ||
problem, [open a new one](https://github.com/interes-group/PEVS-DSA-BIAX10031/issues/new). | ||
* Include a **title and clear description** | ||
* Describe: | ||
* What you did (ideally with a code sample or executed steps) | ||
* What you expected to happen | ||
* What actually happened, including any error messages or program output. | ||
|
||
### Contributing Features | ||
|
||
If you've got a great idea for a feature, start by checking | ||
[issues](https://github.com/interes-group/PEVS-DSA-BIAX10031/labels/improvement) to check we're not already tracking it, or | ||
that your idea hasn't already been rejected. | ||
|
||
If not, start by [opening an issue](https://github.com/interes-group/PEVS-DSA-BIAX10031/issues/new) that describes your idea. | ||
Do not be afraid of rejection, every excellent idea has to start somewhere. Give it a well described solution to the | ||
problem which your proposition is trying to solve. | ||
|
||
## Code and Content Standards | ||
|
||
- **Code:** | ||
- Follow best practices for HTML, CSS, and Hugo templating. | ||
- Ensure that code is clean, well-commented, and formatted consistently. | ||
- **Content:** | ||
- Verify that any new or updated content is accurate and relevant to the course. | ||
- Use clear headings and proper markdown formatting to maintain readability. | ||
- **Style Guidelines:** | ||
- Keep commit messages brief yet descriptive. | ||
- Adhere to the existing structure of the repository to maintain a uniform look and feel. | ||
|
||
## Review Process | ||
|
||
- **Pull Request Review:** | ||
All contributions are subject to review by the maintainers. You may be asked to make revisions before your changes are | ||
merged. | ||
- **Feedback:** | ||
Constructive feedback is provided to help improve your contribution. Please respond to any questions or suggestions in | ||
a timely manner. | ||
|
||
## Communication | ||
|
||
- **Issues and Discussions:** | ||
For broader questions or discussions, please use | ||
the [Issues](https://github.com/Interes-Group/PEVS-DSA-BIAX10031/issues) section. | ||
- **Code of Conduct:** | ||
All contributors are expected to adhere to our [Code of Conduct](CODE_OF_CONDUCT.md). Respectful and collaborative | ||
interactions are key to maintaining a positive environment. | ||
|
||
--- | ||
|
||
Thank you for helping make the PEVŠ DSA BIAX10031 course website a valuable resource for everyone! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,115 @@ | ||
# PEVŠ DSA BIAX10031 course | ||
# PANEUROUNI Dátové štruktúry a algoritmy - BIAX10031 course | ||
|
||
Website for the university course. | ||
 | ||
 | ||
[](https://github.com/Interes-Group/PEVS-DSA-BIAX10031/actions/workflows/gh-pages.yaml) | ||
|
||
I will complete this file later. | ||
This repository hosts the website for the university course **"Dátové štruktúry a algoritmy"** (Data Structures and | ||
Algorithms) for the 2024/2025 summer semester. Built with [Hugo](https://gohugo.io/) | ||
and [Hextra theme](https://github.com/imfing/hextra), this site provides course | ||
materials, announcements, and additional resources to support both students and instructors. | ||
|
||
## Features | ||
|
||
- **Course Materials:** Syllabus, lecture notes, assignments, and additional resources. | ||
- **Announcements:** Stay updated with the latest course-related news. | ||
- **Responsive Design:** Optimized for both desktop and mobile viewing. | ||
- **Static Site Generator:** Powered by Hugo with Hextra theme for fast, secure, and easy-to-maintain content. | ||
|
||
## Prerequisites | ||
|
||
- **Hugo:** Version 0.143 or higher is recommended. | ||
Installation instructions can be found on the [Hugo website](https://gohugo.io/getting-started/installing/). | ||
- **Git:** Basic knowledge of Git is necessary to clone the repository and contribute. | ||
|
||
## Getting Started | ||
|
||
### Clone the Repository | ||
|
||
Open your terminal and run: | ||
|
||
```bash | ||
git clone https://github.com/Interes-Group/PEVS-DSA-BIAX10031.git | ||
cd PEVS-DSA-BIAX10031 | ||
``` | ||
|
||
### Local Development | ||
|
||
1. **Install Hugo:** | ||
Follow the [official installation guide](https://gohugo.io/getting-started/installing/). | ||
|
||
2. **Start the Hugo Server:** | ||
|
||
```bash | ||
hugo server --buildDrafts --disableFastRender | ||
``` | ||
|
||
Open your browser and visit [http://localhost:1313](http://localhost:1313) to preview the website. | ||
|
||
### Building the Site | ||
|
||
To generate the static site files, run: | ||
|
||
```bash | ||
hugo --gc --minify | ||
``` | ||
|
||
The static site will be output to the `public` directory, ready for deployment. | ||
|
||
## Usage | ||
|
||
This repository is structured to make updating course content straightforward. You can modify existing pages, add new | ||
content, or adjust the layout and styling according to the needs of the course. All changes will automatically update | ||
the site when the Hugo server is running. | ||
|
||
Content is structured based on part of the course. All learning material is in content folder with these sub-folders | ||
|
||
- **assignments** - Term assignments to students to work during the term. These should be evaluated with points value. | ||
- **examples** - Practical examples to further explain course topics. | ||
- **exercises** - Task and exercises to more practice course topics for students. | ||
- **lectures** - Recording and materials of lectures. | ||
- **other** - Other materials and manual that could help students in their study. | ||
|
||
## Contributing | ||
|
||
Contributions to improve this course website are welcome. Please follow these guidelines: | ||
|
||
1. **Fork the repository.** | ||
2. **Create a feature branch:** | ||
|
||
```bash | ||
git checkout -b feature/my-feature | ||
``` | ||
|
||
3. **Commit your changes:** | ||
|
||
```bash | ||
git commit -m "Description of your feature" | ||
``` | ||
|
||
4. **Push to your fork:** | ||
|
||
```bash | ||
git push origin feature/my-feature | ||
``` | ||
|
||
5. **Open a Pull Request** detailing the changes and improvements. | ||
|
||
For any changes or suggestions, please open an issue first to discuss your ideas. | ||
|
||
## Code of Conduct | ||
|
||
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold these standards. | ||
|
||
## License | ||
|
||
This project is licensed under the [Apache-2.0 License](LICENSE). | ||
|
||
## Contact | ||
|
||
For any questions, issues, or suggestions, please open an issue on GitHub or reach out directly to the repository | ||
maintainers. | ||
|
||
--- | ||
|
||
Happy learning and coding! |
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters