{"id":21445825,"url":"https://github.com/developer-sujon/pimjo-blog","last_synced_at":"2025-03-17T01:23:24.277Z","repository":{"id":241187965,"uuid":"804532835","full_name":"developer-sujon/pimjo-blog","owner":"developer-sujon","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-22T22:19:29.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-05-22T22:38:26.862Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/developer-sujon.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":"2024-05-22T19:09:26.000Z","updated_at":"2024-05-22T22:38:30.751Z","dependencies_parsed_at":"2024-05-22T22:49:24.143Z","dependency_job_id":null,"html_url":"https://github.com/developer-sujon/pimjo-blog","commit_stats":null,"previous_names":["developer-sujon/pimjo-blog"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developer-sujon%2Fpimjo-blog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developer-sujon%2Fpimjo-blog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developer-sujon%2Fpimjo-blog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/developer-sujon%2Fpimjo-blog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/developer-sujon","download_url":"https://codeload.github.com/developer-sujon/pimjo-blog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243955729,"owners_count":20374374,"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-11-23T02:39:08.936Z","updated_at":"2025-03-17T01:23:24.252Z","avatar_url":"https://github.com/developer-sujon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pimjo Blog API\n\n**Version:** 1.0.0  \n**Date:** 25/May/2024\n\n## Table of Contents\n\n1. [Introduction](#1-introduction)\n2. [Customer Support](#2-customer-support)\n3. [Api Documentation and ER Diagram](#3-api-documentation)\n4. [Running The Application Locally](#4-running-the-application-locally)\n\n## 1. Introduction\n\nThis simple blog API application allows users to create accounts, log in, and publish articles that are publicly visible. It provides robust authentication, thorough error handling, and complete testing, making it a reliable and user-friendly platform for blogging.\n\n### 2 Customer Support\n\nFor support, please contact [muhammad.sujon.cse@gmail.com](mailto:muhammad.sujon.cse@gmail.com).\n\n### 3 Api Documentation\n\n### 3.1 Swagger Documentation\n\nAPI documentation for Pimjo Blog API can be found at [API Swagger Documentation](https://app.swaggerhub.com/apis/DEVOLOPERSUJON/pimjo-blog-api/1.0.0).\n\n### 3.2 ER Diagram\n\nER Diagram for Pimjo Blog API can be found at [ER Diagram.drawio](https://drive.google.com/file/d/1OlHWHY4lbwEHLU4EMQIU9lDhmM7LAyO1/view?usp=sharing).\n\n---\n\n## 4 Running the Application Locally\n\nFollow these steps to set up and run the Pimjo Blog API on your local machine:\n\n### Prerequisites\n\nBefore you begin, ensure that you have the following prerequisites installed:\n\n- [Node.js](https://nodejs.org/)\n- [Yarn](https://classic.yarnpkg.com/en/docs/install/)\n\n### 1. Clone the Project\n\nClone the project repository from GitHub using the following command:\n\n```bash\ngit clone https://github.com/developer-sujon/pimjo-blog.git\n\n```\n\n### 2. Navigate to the Project Directory\n\nChange your working directory to the project folder:\n\n```\ncd pimjo-blog\n\n```\n\n### 3. Install Project Dependencies\n\nChange your working directory to the project folder:\n\n```bash\nyarn install\n```\n\n## Set Up Environment Variables\n\nCreate an .env file in the root directory of the project and configure the necessary environment variables. Here's an example of the required variables:\n\n```env\n#port\nPORT=8080\n\n# MongoDB Database Configuration\nDB_USERNAME=testuser\nDB_PASSWORD=testpassword\nDB_CONNECTION_URL=mongodb://\u003cusername\u003e:\u003cpassword\u003e@localhost:27017\nDB_URL_QUERY=retryWrites=true\u0026w=majority\nAPP_DB_NAME=pimjo-blog-api\nTEST_DB_NAME=pimjo-blog-test-api\n\n# JWT Secret Key\nACCESS_TOKEN_SECRET=your-secret-key\n```\n\n## 5. Run the Database Seed Command\n\n## 6. Start the Application\n\n## 6.1. Test the Application with jest\n\n```bash\nyarn start:test\n```\n\n## 6.2. Start the Application with nodemon\n\n```bash\nyarn start:dev\n```\n\n## 6.3. Start the Application with pm2\n\n```bash\nyarn start:prod\n```\n\n## 7. Access the Application\n\nDemo Credentials\n\n```bash\nemail: user@example.com\npassword: 123456@\n```\n\nOpen a web browser and go to the following URL to access the locally/production running Pimjo Blog API application health:\n\n## 7.1. Access the Application locally\n\n```\nhttp://localhost:8080/health\n\n```\n\nYou can also explore the Swagger API documentation at:\n\n```\nhttp://localhost:8080/docs\n\n```\n\n## 7.1. Access the Application production\n\n```\nhttp://64.176.83.202:8080/health\n\n```\n\nYou can also explore the Swagger API documentation at:\n\n```\nhttp://64.176.83.202:8080/docs\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-sujon%2Fpimjo-blog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeveloper-sujon%2Fpimjo-blog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeveloper-sujon%2Fpimjo-blog/lists"}