{"id":46232710,"url":"https://github.com/sufst/back-end","last_synced_at":"2026-03-03T18:10:57.223Z","repository":{"id":41375469,"uuid":"348833584","full_name":"sufst/back-end","owner":"sufst","description":"The SUFST telemetry back-end server.","archived":false,"fork":false,"pushed_at":"2024-04-30T17:21:14.000Z","size":168,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-04-30T18:35:40.246Z","etag":null,"topics":["telemetry"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sufst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-17T19:48:58.000Z","updated_at":"2024-04-30T17:22:37.000Z","dependencies_parsed_at":"2024-04-30T18:35:11.766Z","dependency_job_id":"1045ee0a-ddaa-4c4b-a3b9-419230a7eb45","html_url":"https://github.com/sufst/back-end","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sufst/back-end","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sufst%2Fback-end","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sufst%2Fback-end/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sufst%2Fback-end/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sufst%2Fback-end/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sufst","download_url":"https://codeload.github.com/sufst/back-end/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sufst%2Fback-end/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30054110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T17:46:22.538Z","status":"ssl_error","status_checked_at":"2026-03-03T17:46:22.036Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["telemetry"],"created_at":"2026-03-03T18:10:56.588Z","updated_at":"2026-03-03T18:10:57.216Z","avatar_url":"https://github.com/sufst.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Back-End Server\nThe SUFST back-end server. This server acts as a **Web-Socket** server and has 2 main purposes.\n\n- The intermediate-server connects to it to distribute all the data from the Xbee module. \n- The front-end clients connect to it to perform all authentication operations, CRUD actions and retrieve live sensor data.\n\n## Running Locally \nPrerequisites: \n- `Git`\n- Python 3.9 \n\nPlease note that only Python3.9 can be used to build the server. If you have another version of python installed locally, you won't be able to run the server locally from your computer but only from docker container. \n\nNow follow the steps below:  \n\n#### 1. Clone the Repository\nOpen a terminal window, navigate to a folder of your choice and run the following command to clone the repository from GitHub. \n\n```\ngit clone https://github.com/sufst/back-end.git\n```\n\nWhen this is done, change directory into the cloned folder using `cd back-end`. \n\n#### 2. Run Installation Script\n\nYou can now run the installation script to install all requirements to your computer. You can do this with: \n\n```\nbash install.sh\n```\n\nA virtual environment (venv) is now created locally on your computer. You can use that to run the server locally using the following: \n\n```\nsource venv/bin/activate\npython server.py\n```\n\nNote: If - in the end - you want to exit the `venv` you need to run `deactivate`. \n\n## Running Locally with Docker\nTo run the server you first need to have Docker installed on your machine. The recommended way to do this in Windows and macOS is with the Docker Desktop application. Installing this will also install the `docker` command on your machine. \n\nIf you use macOS, you can also install Docker with Homebrew. \n\nYou also need to have `git` installed on your machine. Instructions for how to do this on all major Operating Systems are provided in the SUFST Documentation website. \n\nNow follow the steps below:  \n\n#### 1. Clone the Repository\nOpen a terminal window, navigate to a folder of your choice and run the following command to clone the repository from GitHub. \n\n```\ngit clone https://github.com/sufst/back-end.git\n```\n\nWhen this is done, change directory into the cloned folder using `cd back-end`. \n\n#### 2. Launch Docker \nFrom within the `back-end` folder, simply run the `run_docker.sh` script. This will build a Docker image and launch a container with that image. For this, run: \n\n```\nbash run_docker.sh\n```\n\nYou can also run the script using `./run_docker.sh` however make sure to first give it the appropriate permissions using `chmod`. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsufst%2Fback-end","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsufst%2Fback-end","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsufst%2Fback-end/lists"}