{"id":15187325,"url":"https://github.com/shiftkey-labs/shiftkey-server","last_synced_at":"2026-03-03T01:39:15.500Z","repository":{"id":213616610,"uuid":"704097702","full_name":"shiftkey-labs/shiftkey-server","owner":"shiftkey-labs","description":"Web server built for Shiftkey's cross platform interfaces. This repository contains the API code for the Shiftkey App, which is built using Go and Gin framework. The API interacts with a PostgreSQL database to store and retrieve data.","archived":false,"fork":false,"pushed_at":"2023-12-23T07:54:31.000Z","size":22,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-26T08:25:03.767Z","etag":null,"topics":["gin","gin-gonic","go","golang","gorm","postgres","postgresql"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shiftkey-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-10-12T14:28:46.000Z","updated_at":"2024-08-03T20:39:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"cb4e3813-cf98-4489-b68f-b298843ada11","html_url":"https://github.com/shiftkey-labs/shiftkey-server","commit_stats":null,"previous_names":["shiftkey-labs/shiftkey-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/shiftkey-labs/shiftkey-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiftkey-labs%2Fshiftkey-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiftkey-labs%2Fshiftkey-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiftkey-labs%2Fshiftkey-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiftkey-labs%2Fshiftkey-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shiftkey-labs","download_url":"https://codeload.github.com/shiftkey-labs/shiftkey-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shiftkey-labs%2Fshiftkey-server/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30029705,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T00:31:48.536Z","status":"ssl_error","status_checked_at":"2026-03-03T00:30:56.176Z","response_time":60,"last_error":"SSL_read: 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":["gin","gin-gonic","go","golang","gorm","postgres","postgresql"],"created_at":"2024-09-27T18:20:19.154Z","updated_at":"2026-03-03T01:39:15.471Z","avatar_url":"https://github.com/shiftkey-labs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Shiftkey App Server\n\nThis repository contains the API code for the Shiftkey App, which is built using Go and Gin framework. The API interacts with a PostgreSQL database to store and retrieve data.\n\n## Index\n\n- [Prerequisites](#prerequisites)\n- [Getting Started](#getting-started)\n- [API Endpoints](#api-endpoints)\n  - [Users](#users)\n  - [Events](#events)\n  - [Attendance](#attendance)\n  - [Hosts](#hosts)\n  - [Authentication](#authentication)\n- [Database Schema](#database-schema)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Prerequisites\n\nBefore running the API, make sure you have the following installed:\n\n- Go\n- PostgreSQL\n\n## Getting Started\n\nTo get started with the Shiftkey App API, follow these steps:\n\n1. Clone the repository:\n\n   ```shell\n   git clone https://github.com/shiftkeyapp/api.git\n   ```\n\n2. Install the dependencies:\n\n   ```shell\n   go mod download\n   ```\n\n3. Set up the PostgreSQL database:\n\n   - Create a new database named `shiftkey-db`.\n   - Create a new `.env` file using the `.env.example` file as a template.\n\n4. Build and run the API:\n\n   ```shell\n   go run cmd/main/main.go\n   ```\n\n   or build and run the API using `run.sh`:\n\n   ```shell\n   ./run.sh\n   ```\n\n   Make sure to give permission to the script before running it:\n\n   ```shell\n   chmod +x run.sh\n   ```\n\n## API Endpoints\n\n### Users\n\n- **GET `/users`**: Retrieve a list of users.\n- **POST `/users`**: Create a new user.\n- **GET `/users/:id`**: Retrieve a specific user by ID.\n- **PUT `/users/:id`**: Update a specific user by ID.\n- **DELETE `/users/:id`**: Delete a specific user by ID.\n\n### Events\n\n- **GET `/events`**: Retrieve a list of events.\n- **POST `/events`**: Create a new event.\n- **GET `/events/:id`**: Retrieve a specific event by ID.\n- **PUT `/events/:id`**: Update a specific event by ID.\n- **DELETE `/events/:id`**: Delete a specific event by ID.\n\n### Attendance\n\n- **GET `/attendance`**: Retrieve attendance records.\n- **POST `/attendance`**: Create an attendance record.\n- **PUT `/attendance/:id`**: Update an attendance record by ID.\n- **DELETE `/attendance/:id`**: Delete an attendance record by ID.\n\n### Hosts\n\n- **GET `/hosts`**: Retrieve a list of hosts.\n- **POST `/hosts`**: Create a new host.\n- **GET `/hosts/:id`**: Retrieve details of a specific host.\n- **PUT `/hosts/:id`**: Update details of a specific host.\n- **DELETE `/hosts/:id`**: Delete a specific host.\n\n### Authentication\n\n- **POST `/auth/login`**: Authenticate a user and return a token.\n- **POST `/auth/register`**: Register a new user.\n- **POST `/auth/logout`**: Log out a user.\n\n## Database Schema\n\n![Database Schema](https://res.cloudinary.com/dhaaujyea/image/upload/v1703309710/sk_server_x8uoyh.png)\n\n## Contributing\n\nIf you would like to contribute to the Shiftkey App API, please follow the guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiftkey-labs%2Fshiftkey-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshiftkey-labs%2Fshiftkey-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshiftkey-labs%2Fshiftkey-server/lists"}