{"id":20236423,"url":"https://github.com/saba-var/folksoul-api","last_synced_at":"2026-04-10T13:31:51.075Z","repository":{"id":175209669,"uuid":"506931611","full_name":"Saba-Var/folksoul-api","owner":"Saba-Var","description":"Using the FolkSoul API you can add / modify / read / delete members, social links and band information","archived":false,"fork":false,"pushed_at":"2022-12-17T07:17:09.000Z","size":3714,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-27T17:55:12.654Z","etag":null,"topics":["express","jsonwebtoken","mongodb","mongoose","nodejs","swagger-ui","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/Saba-Var.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":"2022-06-24T08:15:31.000Z","updated_at":"2023-08-09T10:23:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"bd10245a-9f67-4319-9e77-d090a964543f","html_url":"https://github.com/Saba-Var/folksoul-api","commit_stats":null,"previous_names":["saba-var/folksoul-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Saba-Var/folksoul-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saba-Var%2Ffolksoul-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saba-Var%2Ffolksoul-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saba-Var%2Ffolksoul-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saba-Var%2Ffolksoul-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Saba-Var","download_url":"https://codeload.github.com/Saba-Var/folksoul-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Saba-Var%2Ffolksoul-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31645273,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"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":["express","jsonwebtoken","mongodb","mongoose","nodejs","swagger-ui","typescript"],"created_at":"2024-11-14T08:20:49.709Z","updated_at":"2026-04-10T13:31:51.043Z","avatar_url":"https://github.com/Saba-Var.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eFolkSoul API\u003c/h1\u003e\n\u003cp\u003eUsing the FolkSoul API you can add / modify / read / delete members, social links and band information\u003c/p\u003e\n\n#\n\n## Table of Contents\n\n- [](#)\n  - [Table of Contents](#table-of-contents)\n- [](#-1)\n  - [Prerequisites](#prerequisites)\n- [](#-2)\n  - [Tech Stack](#tech-stack)\n- [](#-3)\n  - [Getting Started](#getting-started)\n- [](#-4)\n  - [Project Structure](#project-structure)\n- [](#-5)\n  - [Resources](#resources)\n\n#\n\n## Prerequisites\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/nodejs.png\"   height=\"22\"/\u003e \u003cp\u003e_Node JS @12.X and up_\u003c/p\u003e\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/npm.png\"   height=\"20\"/\u003e \u003cp\u003e_npm @6 and up_\u003c/p\u003e\n\n#\n\n## Tech Stack\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/nodejs.png\"   height=\"25\"/\u003e \u003cp\u003e\u003ca href=\"https://nodejs.org/en/\" target=\"_blank\"\u003e[NodeJS @16.15.1]\u003c/a\u003e - JavaScript runtime built on Chrome's V8 JavaScript engine\u003cp/\u003e\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/express.png\"   height=\"25\"/\u003e \u003cp\u003e\u003ca href=\"https://expressjs.com/\" target=\"_blank\"\u003e[Express @4.18.1]\u003c/a\u003e - Fast, unopinionated, minimalist web framework for Node.js\u003cp/\u003e\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/mongodb.png\"   height=\"25\"/\u003e \u003cp\u003e\u003ca href=\"https://www.mongodb.com/\" target=\"_blank\"\u003e[MongoDB]\u003c/a\u003e - Open source NoSQL database management program\u003cp/\u003e\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/mongoose.png\"   height=\"25\"/\u003e \u003cp\u003e\u003ca href=\"https://mongoosejs.com/\" target=\"_blank\"\u003e[mongoose @6.3.6]\u003c/a\u003e - elegant mongodb object modeling for node.js\u003cp/\u003e\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/typescript.png\"   height=\"20\"/\u003e \u003cp\u003e\u003ca href=\"https://www.typescriptlang.org/\" target=\"_blank\"\u003e[Typescript @4.7.4]\u003c/a\u003e - TypeScript is JavaScript with syntax for types.\u003cp/\u003e\n\n- \u003cimg style=\"padding-right:10px;\" align=\"left\"  src=\"readme/assets/swagger.png\"   height=\"25\"/\u003e \u003cp\u003e\u003ca href=\"https://www.npmjs.com/package/swagger-ui-express\" target=\"_blank\"\u003e[Swagger UI Express @4.4.0]\u003c/a\u003e - Serve auto-generated swagger-ui generated API docs from express\u003cp/\u003e\n\n#\n\n## Getting Started\n\n1\\. First of all you need to clone repository from github:\n\n```sh\ngit clone https://github.com/Saba-Var/folksoul-api.git\n```\n\n2\\. Next step requires install all the dependencies\n\n```sh\nnpm install\n```\n\nor\n\n```sh\nyarn install\n```\n\n3\\. Copy .env\n\n```sh\ncp .env.example .env\n```\n\n4\\. If you want you can also change default configuration of .env file and connect to mongodb\n\n```sh\nMONGO_DATABASE=folksoul\nMONGO_PROTOCOL=mongodb\nMONGO_HOST=localhost\nMONGO_PORT=27017\nMONGO_CLUSTER=''\n\nSERVER_PORT=5001\n\nACCESS_TOKEN_SECRET=secret-text\n\nUSER_PASSWORD=***\nUSER_EMAIL=***\n```\n\n5\\. For the first time before run the API run following command:\n\n```sh\nnpx tsc\n```\n\n6\\. after that you can run FolkSoul API from terminal:\n\n```sh\nnpm run dev\n```\n\n7\\. To create new user from the terminal run the following command:\n\n```sh\nnpm run user:create\n```\n\nTo see swagger documentation visit [localhost:5001/api-docs](http://localhost:5001/api-docs)\n\n\n#\n\n## Project Structure\n\n```bash\n├─── readme\n├─── src\n│    ├── bin\n│    ├── config\n│    ├── controllers\n│    ├── middlewares\n│    ├── models\n│    ├── routes\n│    └── schemas\n- .env\n- .eslintrc.json\n- .gitignore\n- .prettierrc.json\n- babel.config.json\n- package.json\n- README.md\n- tsconfig.json\n\n\n```\n\n#\n\n## Resources\n\n- [Application Details](https://redberry.gitbook.io/assignment-iii-folksoul/)\n- [Git commit rules](https://redberry.gitbook.io/resources/git-is-semantikuri-komitebi)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaba-var%2Ffolksoul-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsaba-var%2Ffolksoul-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsaba-var%2Ffolksoul-api/lists"}