Skip to content

SplusEins - Stundenplan und Mensaplan für die Ostfalia Hochschule

License

Notifications You must be signed in to change notification settings

SplusEins/SplusEins

Repository files navigation

SplusEins

GitHub API Workflow Status GitHub Web Workflow Status GitHub Deploy Workflow Status Uptime Robot ratio (30 days)

SplusEins documentation

Issues

Please report any bugs or feature requests to the GitHub issue tracker or write us a mail.

Contributing

Contributions very much welcome! Feel free to write us a mail if you have any questions or just open a new issue. Don't forget to check out the project documentation.

Installation

Follow the next steps if you want to develop/build locally.

Setup frontend

cd web/

# install correct node version (might be optional)
nvm install

# install dependencies
npm install

# Either run with the remote API (at spluseins.de/api)
npm run dev:remote
# Or use the local API, when developing the backend (see below)
npm run dev:local

Setup backend

cd server/

Add your ostfalia credentials as environment variables, preferably in a .env-file.

# ./server/.env
SKED_USER=idxxxxxx
SKED_PASSWORD=your_ostfalia_pw
# install dependencies
npm install

# install correct node version (might be optional)
nvm install

# Set environment variables
CACHE_PATH=spluseins-cache # Linux/Unix
set CACHE_PATH=spluseins-cache # Windows

# start dev api at localhost:3001/api
npm run dev

Setup documentation

cd docs/

# install dependencies
npm install

# serve docs at http://localhost:8080/docs/
npm run dev