Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
C4illin committed Nov 6, 2023
1 parent 36eea61 commit 2ea2cdb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 188 deletions.
160 changes: 1 addition & 159 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,159 +1 @@

Skip to content
Pulls
Issues
Marketplace
Explore
@Flakt
github /
gitignore

3.1k
106k

56k

Code
Pull requests 163
Actions
Projects
Security

Insights

gitignore/Node.gitignore
@ch4ot1c
ch4ot1c Add .yarn/install-state.gz to Node.gitignore (#3407)
Latest commit 7293c14 on May 14
History
58 contributors
@stuartpb
@shiftkey
@SimonSiefke
@TennyZhuang
@venatoria
@ro31337
@Richienb
@melonmanchan
@gouthamve
@jucrouzet
@cheddar
@arcresu
116 lines (86 sloc) 1.77 KB
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
__pycache__/
node_modules/
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 G.U.D. Chalmers
Copyright (c) 2023 G.U.D. Chalmers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
30 changes: 3 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,9 @@
# Lasvecka
A web-application for displaying the current study week at Chalmers University of Technology.
A web-application for displaying the current study week at Chalmers University of Technology.

## How it works
The application is divided into a frontend running React.js, and a backend hosting a python-flask server. The backend scrapes the
[student-portal](https://student.portal.chalmers.se/sv/chalmersstudier/Sidor/Lasarstider.aspx) at Chalmers to get dates, which are then used in the frontend to determine the current study week.
The application is a scraper and a frontend. The scraper scrapes
[student-portal](https://www.student.chalmers.se/sp/academic_year_list) at Chalmers to get dates, which are then used in the frontend to determine the current study week.

## Running the app locally
First, change the code in `WeekDisplay.js` and `app.py` to use localhost:
```javascript
// Use localhost:5000/getData for dev
componentDidMount() {
axios
.get("https://api.lasvecka.nu/getData")
.then(res => {
this.setState({
data: res.data
});
})
.catch(err => {
console.log(err);
});
}
```
```python
if __name__ == '__main__':
# Dev purposes only
# app.run(host="0.0.0.0")

# For prod
serve(app, listen='0.0.0.0:5000')
```
Use command `docker-compose -f dev.docker-compose.yaml up` to run the dev docker-compose.yml.
2 changes: 1 addition & 1 deletion prod.docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: '3'
services:
app:
container_name: lasvecka-node
iamge: ghcr.io/gudchs/lasvecka:main
image: ghcr.io/gudchalmers/lasvecka:main
restart: unless-stopped
ports:
- 3000:3000
Expand Down

0 comments on commit 2ea2cdb

Please sign in to comment.