📝 update README
Signed-off-by: Sindre Kjelsrud <kjelsrudsindre@gmail.com>
This commit is contained in:
		
							parent
							
								
									42f8c0dbfc
								
							
						
					
					
						commit
						c45a65b618
					
				
					 1 changed files with 55 additions and 8 deletions
				
			
		
							
								
								
									
										63
									
								
								README.md
									
										
									
									
									
								
							
							
						
						
									
										63
									
								
								README.md
									
										
									
									
									
								
							|  | @ -1,22 +1,69 @@ | ||||||
| # Helseveileder | # Helseveileder | ||||||
| > Bachelor-project V2024 | > Bachelor-project ~ Spring 2024 | ||||||
|  | 
 | ||||||
|  | ## 📋 Table of Contents | ||||||
|  | 
 | ||||||
|  | 1. 📝 [Info](#info) | ||||||
|  | 2. ⚙️ [Tech Stack](#tech-stack) | ||||||
|  | 3. 🔋 [Features](#features) | ||||||
|  | 4. 🤸 [Quick Start](#quick-start) | ||||||
|  | 5. 🔗 [Links](#links) | ||||||
|  | 6. 📄 [License](#license) | ||||||
| 
 | 
 | ||||||
| ## 📝 Info | ## 📝 Info | ||||||
| 
 | 
 | ||||||
| Our Bachelor-project is in collaboration with medical students and researchers from UiB.  | This repository contains our Bachelor project for Spring 2024. This project is a collaborative effort with medical students and researchers from UiB (University of Bergen).  | ||||||
| 
 | 
 | ||||||
| As a part of this project we needed to scrape questions and answers from [Studenterspør.no](https://studenterspor.no/). This meant that we needed to code a webscraper as well, which you can check out [here](https://github.com/SindreKjelsrud/helseveileder_webscraper) if you would like to see the source code. | As a part of this project we needed to scrape questions and answers from [Studenterspør.no](https://studenterspor.no/). This involved developing a webscraper to extract the necessary data. You can explore the source code [here](https://github.com/SindreKjelsrud/helseveileder_webscraper). | ||||||
| 
 | 
 | ||||||
| ## 🏗️ Technologies | ## ⚙️ Tech Stack | ||||||
| 
 | 
 | ||||||
| Backend: Go | - Go | ||||||
|  | - Svelte | ||||||
|  | - TypeScript | ||||||
|  | - Tailwind CSS | ||||||
|  | - PostgreSQL | ||||||
| 
 | 
 | ||||||
| Frontend: Svelte | ## 🔋 Features | ||||||
| 
 | 
 | ||||||
| Database: PostgreSQL | 👉 **XYxy:** Aabbcc. | ||||||
| 
 | 
 | ||||||
| ## 🛠️ How to run locally | ## 🤸 Quick Start | ||||||
|  | 
 | ||||||
|  | Follow these steps to set up the project locally on your machine. | ||||||
|  | 
 | ||||||
|  | **Prerequisites** | ||||||
|  | 
 | ||||||
|  | Make sure you have the following installed on your machine: | ||||||
|  | 
 | ||||||
|  | - ... | ||||||
|  | 
 | ||||||
|  | **Cloning the Repository** | ||||||
|  | 
 | ||||||
|  | ```bash | ||||||
|  | git clone git@github.com:haraldnilsen/helseveileder.git  | ||||||
|  | cd helseveileder | ||||||
|  | ``` | ||||||
|  | 
 | ||||||
|  | **Installation** | ||||||
|  | 
 | ||||||
|  | ```bash | ||||||
| 
 | 
 | ||||||
| ``` | ``` | ||||||
| 
 | 
 | ||||||
|  | **Running the Project** | ||||||
|  | 
 | ||||||
|  | ```bash | ||||||
|  | 
 | ||||||
| ``` | ``` | ||||||
|  | 
 | ||||||
|  | ## 🔗 Links | ||||||
|  | 
 | ||||||
|  | See also links below for related info about project: | ||||||
|  | 
 | ||||||
|  | - [Helseveileder-webscraper](https://github.com/SindreKjelsrud/helseveileder_webscraper) | ||||||
|  | - [Helseveileder-LLM](https://github.com/alu042/helseveileder-llm) | ||||||
|  | 
 | ||||||
|  | ## 📄 Licence | ||||||
|  | 
 | ||||||
|  | This project is licensed under the [MIT License](./LICENSE). | ||||||
|  |  | ||||||
		Reference in a new issue
	
	 Sindre Kjelsrud
						Sindre Kjelsrud