{"id":15103826,"url":"https://github.com/dunkeyyfong/fnapi","last_synced_at":"2026-02-01T21:35:49.080Z","repository":{"id":257204180,"uuid":"857610262","full_name":"dunkeyyfong/FnAPI","owner":"dunkeyyfong","description":"FnAPI is a simple API project hosted on GitHub Pages, designed to provide an easy-to-use and extendable platform for web and mobile applications. It offers basic user management features and a straightforward web interface for interacting with the API.","archived":false,"fork":false,"pushed_at":"2024-09-15T06:02:07.000Z","size":50,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-01T23:05:58.441Z","etag":null,"topics":["api","github","github-pages","presonal-website","vuejs"],"latest_commit_sha":null,"homepage":"","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dunkeyyfong.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2024-09-15T05:45:03.000Z","updated_at":"2024-11-21T03:36:42.000Z","dependencies_parsed_at":"2024-09-15T09:55:05.691Z","dependency_job_id":null,"html_url":"https://github.com/dunkeyyfong/FnAPI","commit_stats":null,"previous_names":["dunkeyyfong/fnapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dunkeyyfong/FnAPI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunkeyyfong%2FFnAPI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunkeyyfong%2FFnAPI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunkeyyfong%2FFnAPI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunkeyyfong%2FFnAPI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dunkeyyfong","download_url":"https://codeload.github.com/dunkeyyfong/FnAPI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dunkeyyfong%2FFnAPI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263047678,"owners_count":23405280,"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":["api","github","github-pages","presonal-website","vuejs"],"created_at":"2024-09-25T19:42:29.284Z","updated_at":"2026-02-01T21:35:49.052Z","avatar_url":"https://github.com/dunkeyyfong.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FnAPI Using GitHub Pages to API\n\n## Overview\n\nFnAPI is a project that utilizes GitHub Pages to host and serve a JSON-based API. This API allows you to manage user data and interact with the data through a web interface.\n\n## Features\n\n- **Dynamic User Management**: Create, read, and update user data using GitHub Pages.\n- **Easy Deployment**: Leveraging GitHub Pages for API hosting and data storage.\n- **Simple Integration**: Easily integrate with other services and applications.\n\n## Setup\n\n### Prerequisites\n\n- **Git**: Ensure that Git is installed on your machine.\n- **GitHub Account**: You need a GitHub account to host the repository and use GitHub Pages.\n\n### Steps to Set Up\n\n1. **Clone the Repository**\n\n   ```bash\n   git clone https://github.com/yourusername/FnAPI.git\n   cd FnAPI\n   ```\n\n2. **Set Up Environment Variables**\n\n   Create a `.env` file in the root directory of the project with the following content:\n\n   ```env\n   VITE_FILE_PATH=user.json\n   VITE_REPO_OWNER=yourusername\n   VITE_REPO_NAME=yourrepository\n   VITE_ACCESS_TOKEN=your_github_access_token\n   VITE_BRANCH_NAME=main\n   ```\n\n3. **Configure GitHub Pages**\n\n   - Go to the GitHub repository page.\n   - Navigate to **Settings** \u003e **Pages**.\n   - Select the branch (`main` or `gh-pages`) and folder (usually `/root`).\n   - Save the settings.\n\n4. **Run the Application**\n\n   If you are using a local development environment, start your application. For example, if you're using Vue:\n\n   ```bash\n   npm install\n   npm run serve\n   ```\n\n5. **Deploy Changes**\n\n   Push your changes to GitHub:\n\n   ```bash\n   git add .\n   git commit -m \"Initial setup for FnAPI\"\n   git push origin main\n   ```\n\n## Usage\n\n### Creating a User\n\nTo create a new user, simply use the web interface provided by the GitHub Pages site. Fill in the user details and click \"Create User.\"\n\n### Updating the API File\n\nThe API file (`user.json`) will be updated automatically whenever a new user is created or existing data is modified.\n\n[Example API](https://dunkeyyfong.github.io/user.json)\n\n## Troubleshooting\n\n### Unauthorized Error\n\nIf you encounter a 401 Unauthorized error:\n\n- Check that your GitHub access token is correct and has the necessary permissions.\n- Ensure that the `.env` file is correctly configured.\n\n### Conflict Error\n\nIf you encounter a 409 Conflict error:\n\n- Make sure that you have resolved any potential conflicts in the `user.json` file before pushing changes.\n- Check if there are concurrent modifications and resolve them.\n\n## Contributing\n\nFeel free to contribute to the project by submitting issues or pull requests. For more details, check out the [contributing guide](CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunkeyyfong%2Ffnapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdunkeyyfong%2Ffnapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdunkeyyfong%2Ffnapi/lists"}