Skip to content

SplusEins/SplusEins

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
 
 
 
 
web
 
 
 
 
 
 
 
 
 
 

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 dependencies
npm install

# Set environment variables to use the remote api
API_URL=https://spluseins.de/ #Linux/Unix
set API_URL=https://spluseins.de/ #Windows
# If you want to use your own backend (see below in backend setup), set this instead:
API_URL="http://127.0.0.1:3001"

# serve with hot reload at localhost:3000
npm run dev

# Optional: generate static project inside dist/
npm run generate

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

# 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