{"id":22929919,"url":"https://github.com/genocs/genocs-library-docs","last_synced_at":"2025-07-18T11:07:26.410Z","repository":{"id":167870411,"uuid":"640251015","full_name":"Genocs/genocs-library-docs","owner":"Genocs","description":"The Genocs library documentation.","archived":false,"fork":false,"pushed_at":"2025-03-01T18:42:19.000Z","size":29288,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-01T19:33:16.402Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://genocs-blog.netlify.app/","language":"HTML","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/Genocs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"open_collective":"genocs","custom":["https://www.buymeacoffee.com/genocs"]}},"created_at":"2023-05-13T13:27:09.000Z","updated_at":"2025-03-01T18:42:22.000Z","dependencies_parsed_at":"2025-01-31T16:33:11.274Z","dependency_job_id":"feea008c-2bd5-41df-903d-cbe062f6beee","html_url":"https://github.com/Genocs/genocs-library-docs","commit_stats":null,"previous_names":["genocs/genocs-library-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genocs%2Fgenocs-library-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genocs%2Fgenocs-library-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genocs%2Fgenocs-library-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Genocs%2Fgenocs-library-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Genocs","download_url":"https://codeload.github.com/Genocs/genocs-library-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246672960,"owners_count":20815484,"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":["documentation"],"created_at":"2024-12-14T10:19:43.345Z","updated_at":"2025-04-01T16:44:33.590Z","avatar_url":"https://github.com/Genocs.png","language":"HTML","funding_links":["https://opencollective.com/genocs","https://www.buymeacoffee.com/genocs"],"categories":[],"sub_categories":[],"readme":"# Genocs Library's Documentation\n\n[![Discord](https://img.shields.io/discord/1106846706512953385?color=%237289da\u0026label=Discord\u0026logo=discord\u0026logoColor=%237289da\u0026style=flat-square)](https://discord.com/invite/fWwArnkV)\n[![Twitter](https://img.shields.io/twitter/follow/genocs?color=1DA1F2\u0026label=Twitter\u0026logo=Twitter\u0026style=flat-square)](https://twitter.com/genocs)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/6dbb93bc-ad39-4fda-849a-e542abdcfa7c/deploy-status)](https://app.netlify.com/sites/genocs-blog/deploys)\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"genocs-library-logo.png\" alt=\"icon\"\u003e\n\u003c/p\u003e\n\n## How to contribute?\n\n1. Fork this Repository.\n2. Navigate to your newly forked Repository -\u003e Settings -\u003e Secrets.\n3. Here, Add a new Repository Secret with a name `GT_TOKEN`. As for the value, paste in your GitHub Token (https://github.com/settings/tokens)\n4. Now, clone this repository locally.\n5. Ensure that you have Node.js and Visual Code installed.\n6. At the root of the repository run `npm install`. This installs all the required packages.\n7. All the documentations are to be written in markdown format.\n8. Refer https://github.com/Genocs/genocs-library-docs/blob/main/content/en/templates/general/getting-started/index.md to get an idea on how to write documentation and include images, code snippets and stuff.\n9. To run the application locally, run the command `npm run start` and navigate to localhost:1313\n10. Once ready, send a Pull Request.\n\n\n# How to build and run on Docker\n\n1. Clone the repository\n2. Run the following command to build the docker image\n    ```bash\n    # build the application release version\n    npm run build\n    \n    # build the docker image\n    docker build -t genocs/genocs-library-docs .\n    \n    # tag the image\n    docker tag genocs/genocs-library-docs genocs/genocs-library-docs:1.1.4\n    docker tag genocs/genocs-library-docs genocs/genocs-library-docs:latest\n    \n    # login to docker hub\n    docker login\n    \n    # push the image to docker hub\n    docker push genocs/genocs-library-docs:1.1.4\n    docker push genocs/genocs-library-docs:latest\n    ```\n3. Run the following command to run the docker image on localhost:1613\n    ```bash\n    docker run -d -p 1613:80 genocs/genocs-library-docs\n    ```\n4. Navigate to localhost:1613 to view the documentation\n\n\n## Acknowledgment\n\n- Original theme [h-enk doks](https://github.com/h-enk/doks)\n- Original project [fullstackhero](https://github.com/fullstackhero)\n- Awesome mentor [Mukesh Murugan](https://github.com/iammukeshm)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenocs%2Fgenocs-library-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgenocs%2Fgenocs-library-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgenocs%2Fgenocs-library-docs/lists"}