{"id":13614473,"url":"https://github.com/CoRfr/spex-3gpp","last_synced_at":"2025-04-13T18:33:07.431Z","repository":{"id":24929649,"uuid":"28346842","full_name":"CoRfr/spex-3gpp","owner":"CoRfr","description":"A WebService to deliver 3GPP specifications.","archived":false,"fork":false,"pushed_at":"2023-01-19T11:02:57.000Z","size":565,"stargazers_count":34,"open_issues_count":10,"forks_count":17,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-11-07T22:42:33.602Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/CoRfr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING.GPLv3","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-22T16:20:35.000Z","updated_at":"2024-10-25T10:33:54.000Z","dependencies_parsed_at":"2023-02-10T23:00:46.958Z","dependency_job_id":null,"html_url":"https://github.com/CoRfr/spex-3gpp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoRfr%2Fspex-3gpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoRfr%2Fspex-3gpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoRfr%2Fspex-3gpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CoRfr%2Fspex-3gpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CoRfr","download_url":"https://codeload.github.com/CoRfr/spex-3gpp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248760663,"owners_count":21157406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-08-01T20:01:01.889Z","updated_at":"2025-04-13T18:33:06.868Z","avatar_url":"https://github.com/CoRfr.png","language":"JavaScript","funding_links":[],"categories":["Tools"],"sub_categories":["Diameter"],"readme":"# This is speX\n\nI found the 3GPP documents hard to find, hard to stay up-to-date, etc ...\nSo this is an alternative service to expose 3GPP specifications in a different architecture.\n\nFeel free to fork.\n\nService is provided at http://spex.cor-net.org\n\n## How to run the service\n\n### Using Docker\n\nThe docker image is available as `corfr/spex` or from sources:\n```\nhost:spex$ docker build -t spex .\n```\n\nIn the following we'll run the spex container. Along with it comes a MySQL database and a docker volume for data storage.\n\n```console\nhost:~$ docker volume create spex-storage\nhost:~$ docker network create spex-net\nhost:~$ docker run --name spex-mysql --network spex-net -e MYSQL_ROOT_PASSWORD=spex -d mysql:latest\n```\n```\n# connect to the mysql container\nhost:~$ docker run -it --network spex-net --rm mysql mysql -h spex-mysql -u root -p\n# within mysql, create a new database\nspex-mysql:~$ mysql\nmysql\u003e CREATE DATABASE spex;\n```\n\nNow we can start spex, point it to the MySQL database, and mount the data storage.\n```\nhost:~$ docker run --name spex --network spex-net -e MYSQL_ENV_DB_NAME=spex -e MYSQL_ENV_DB_USER=root -e MYSQL_ENV_DB_PASS=spex -e MYSQL_PORT_3306_TCP_ADDR=spex-mysql -v spex-storage:/home/app/webapp/specs -p 3000:80 corfr/spex\n```\n\nOn first run, you'll need to manually populate the database:\n```\nhost:~$ docker exec -ti -u app spex bash\nspex:~$ cd /home/app/webapp\n# if the database cannot be setup, first disable the security checks\nspex:webapp$ export DISABLE_DATABASE_ENVIRONMENT_CHECK=1\nspex:webapp$ bundle exec rake db:setup\nspex:webapp$ bundle exec /home/app/webapp/script/init_3gpp.rb\n```\n\nThe spex website is now available on `http://localhost:3000`\n\n### Using Docker Compose\n\nFrom the top-level directory:\n```\ndocker-compose pull\ndocker-compose build\ndocker-compose up -d\n```\n\nOn first run, you'll need to manually populate the database:\n```\nhost:~$ docker-compose exec spex bash\nspex:~$ cd /home/app/webapp\n# if the database cannot be setup, first disable the security checks\nspex:webapp$ export DISABLE_DATABASE_ENVIRONMENT_CHECK=1\nspex:webapp$ bundle exec rake db:setup\nspex:webapp$ bundle exec /home/app/webapp/script/init_3gpp.rb\n```\n\nThe spex website is now available on `http://localhost:3000`\n\n### Using rake (development)\n\n```\nbundle install\nbundle exec rails server\n```\n\nTo populate the database, use:\n```\nbundle exec rake db:setup\nscripts/init_3gpp.rb\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCoRfr%2Fspex-3gpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCoRfr%2Fspex-3gpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCoRfr%2Fspex-3gpp/lists"}