{"id":19793274,"url":"https://github.com/carpodok/node-blog-app","last_synced_at":"2026-04-13T03:45:19.025Z","repository":{"id":257109619,"uuid":"846290308","full_name":"carpodok/node-blog-app","owner":"carpodok","description":"Web Blog API project built with Node.js","archived":false,"fork":false,"pushed_at":"2024-10-11T16:24:15.000Z","size":256,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-11T04:35:08.410Z","etag":null,"topics":["blog-app","docker-compose","expressjs","jwt-authentication","mongodb","nodejs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/carpodok.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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-08-22T22:47:29.000Z","updated_at":"2024-10-11T16:24:19.000Z","dependencies_parsed_at":"2024-09-14T22:36:31.044Z","dependency_job_id":"ba7385c9-cc67-4df6-a328-20a4e28f0dfc","html_url":"https://github.com/carpodok/node-blog-app","commit_stats":null,"previous_names":["carpodok/node-blog-app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carpodok%2Fnode-blog-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carpodok%2Fnode-blog-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carpodok%2Fnode-blog-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/carpodok%2Fnode-blog-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/carpodok","download_url":"https://codeload.github.com/carpodok/node-blog-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241133108,"owners_count":19915338,"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":["blog-app","docker-compose","expressjs","jwt-authentication","mongodb","nodejs"],"created_at":"2024-11-12T07:09:22.391Z","updated_at":"2025-10-24T14:03:10.413Z","avatar_url":"https://github.com/carpodok.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Web Blog API\n\nThis project is a RESTful API for a Web Blog application built using Node.js. It provides a set of endpoints to manage users, posts, and comments. The API supports essential blog functionalities such as user authentication, creating and managing posts, and interacting with comments. \n\n\u003c!--\nhttps://www.postman.com/martian-meteor-939359/workspace/public-workspace/collection/18754010-ec536be0-b388-478e-baa5-b42ba97295b3?action=share\u0026creator=18754010\n--\u003e\n\n\n## Endpoints\nBelow is an overview of the available endpoints and their functionalities.\n- ***To view the Swagger UI schema, navigate to `http://localhost:3000/api-docs` in your browser after running the server.***\n- ***You can test these endpoints via this [Postman](https://www.postman.com/martian-meteor-939359/workspace/alitalhacoban-public-workspace/collection/18754010-ec536be0-b388-478e-baa5-b42ba97295b3?action=share\u0026creator=18754010) collection***\n\n\u003cimg width=\"750\" alt=\"Screenshot 2024-08-31 at 00 08 18\" src=\"https://github.com/user-attachments/assets/e29822e7-4cbf-4428-af04-cf84541f27f4\"\u003e\n\n\n\n\n## Technologies Used\n\n- ***Node.js:*** Backend runtime environment.\n- ***express.js:*** Web framework for Node.js.\n- ***MongoDB:*** NoSQL database for storing user data.\n- ***mongoose:*** ODM for MongoDB.\n- ***express-validator:*** Server side validation for input fields\n- ***bcrypt:*** Library for hashing passwords.\n- ***JSON Web Tokens (JWT):*** Standard for creating secure access tokens.\n- ***swagger-ui-express:*** Middleware to serve auto-generated Swagger API documentation in Express.js applications.\n- ***swagger-jsdoc:*** Library to generate Swagger API documentation from JSDoc comments in your code.\n- ***jest:*** Comprehensive testing of API endpoints using jest for unit tests and supertest for testing HTTP requests, ensuring reliable and consistent API functionality.\n\u003c!-- - ***jest:*** Testing framework for JavaScript, used to write and run unit tests. \n- ***supertest:*** Library for testing HTTP endpoints in Node.js applications. --\u003e\n\n\n\n ## Installation\n  1. Clone the repository\n  \n  ```bash\n    git clone https://github.com/carpodok/node-blog-app.git\n  ```\n  \n  2. Navigate to the project directory:\n  \n   ```bash\n    cd node-blog-app\n   ```\n\n  3. Install required dependencies\n  \n  ```bash\n   npm install\n  ```\n\u003cbr\u003e\n\n## Configuration\n\n1. Creat a `.env` file on the root of the project and add the following environment variables\n\n```\nPORT=3000\nMONGODB_URL=your_mongodb_uri\nJWT_SECRET=your_jwt_secret\n```\n\n\u003cbr\u003e\n\n## Running the Application\n\n1. To start the server, run the following command on the root of the project path;\n\n```\nnpm start\n```\n\nFor the development purpose;\n```\nnpm run dev\n```\n\n2. The application will be running on  `http://localhost:3000`\n\n\u003cbr\u003e\n\n## Running the Application with Docker\nYou can also run this application using Docker\n\n1. Ensure Docker and Docker Compose are installed. If not, follow the [official Docker installation guide](https://docs.docker.com/engine/install/).\n\n2. Build and run the applicaiton with Docker Compose:\n   ```bash\n   docker-compose up\n   ```\n    The application will be accessible at `http://localhost:3000`\n  \n3. ***Using a custom `.env` file:***  Ensure you have a `.env` file with the required environment variables (`PORT`, `MONGODB_URL`, `JWT_SECRET`), as it will be loaded automatically.\n\n## Contributing\nContributions are welcome! Please open an issue or submit a pull request for any improvements or suggestions.\n\n\n## License\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarpodok%2Fnode-blog-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcarpodok%2Fnode-blog-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcarpodok%2Fnode-blog-app/lists"}