{"id":23707141,"url":"https://github.com/atmaram-kambli/node-server-setup-npm-package","last_synced_at":"2026-04-10T13:32:23.323Z","repository":{"id":270223274,"uuid":"899929124","full_name":"atmaram-kambli/node-server-setup-npm-package","owner":"atmaram-kambli","description":"A NPM  package to quickly set up a Node.js server with an initial project structure, including boilerplate code, and configuration for authentication, routing, and database setup","archived":false,"fork":false,"pushed_at":"2024-12-29T13:36:23.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-29T09:59:40.448Z","etag":null,"topics":["expressjs","jwt","mongodb","mvc","nodejs","npm","npm-package"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/node-server-setup","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/atmaram-kambli.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-12-07T12:03:57.000Z","updated_at":"2025-01-09T16:16:02.000Z","dependencies_parsed_at":"2024-12-29T14:34:32.924Z","dependency_job_id":"dc0f15d8-2d09-46b1-87c7-1d74fecbccd8","html_url":"https://github.com/atmaram-kambli/node-server-setup-npm-package","commit_stats":null,"previous_names":["atmaram-kambli/node-server-setup-npm-package"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/atmaram-kambli/node-server-setup-npm-package","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atmaram-kambli%2Fnode-server-setup-npm-package","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atmaram-kambli%2Fnode-server-setup-npm-package/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atmaram-kambli%2Fnode-server-setup-npm-package/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atmaram-kambli%2Fnode-server-setup-npm-package/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atmaram-kambli","download_url":"https://codeload.github.com/atmaram-kambli/node-server-setup-npm-package/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atmaram-kambli%2Fnode-server-setup-npm-package/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31645284,"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":["expressjs","jwt","mongodb","mvc","nodejs","npm","npm-package"],"created_at":"2024-12-30T16:19:41.416Z","updated_at":"2026-04-10T13:32:23.290Z","avatar_url":"https://github.com/atmaram-kambli.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Server Setup\n\n## Overview\n\nA `node-server-setup` is a robust npm package that provides a quick and comprehensive boilerplate for Node.js server development. It offers a pre-configured server structure with integrated user management API, allowing developers to jumpstart their backend projects with minimal setup.\n\n## Features\n\n- Instant Node.js server structure generation\n- Pre-configured user management API \n- Secure JWT authentication mechanism\n- Modular and extensible architecture\n\n### Technical Architecture\n- Express.js backend framework\n- MongoDB database integration\n- JSON Web Token (JWT) authentication\n- Bcrypt password security\n- Cloudinary image upload support\n- Environment-based configuration management\n\n\n## Installation\n\n### Prerequisites\n\n- Node.js (v18.0.0 or higher recommended)\n- npm (Node Package Manager)\n\n### Global Installation\nInstall the package globally using npm:\n\n```bash\nnpm install -g node-server-setup\n```\n\n## Usage\n\n### Creating a New Project\n\nTo create a new Node.js server project, run:\n\n```bash\ncreate-node-server\n```\n\nThis command will:\n- create a new project directory 'server'\n- set up the complete server structure\n\n#### Install Dependencies\n\nAfter creating the project, navigate to the server directory and install the required dependencies:\n\n```bash\ncd server\nnpm install\n```\n\nThis will install all the necessary packages defined in the project's package.json, including:\n\n- Express.js\n- Mongoose\n- JSON Web Token (JWT)\n- Bcrypt\n- Multer\n- Resend\n- and other project-specific dependencies\n\n### Project Structure\n\n```\nmy-project/\n├── server/\n│   ├── config/\n│   ├── controllers/\n│   ├── middlewares/\n│   ├── models/\n│   ├── routes/\n│   ├── services/\n│   └── utils/\n├── .env\n├── package.json\n└── index.js\n```\n\n## Available User Management Endpoints\n\n### Authentication Routes\n\n| Endpoint                   | Method | Description                    | Authentication Required |\n|----------------------------|--------|--------------------------------|-------------------------|\n| `/register`                | POST   | User Registration              | No                      |\n| `/verify-email`            | POST   | Email Verification             | No                      |\n| `/login`                   | POST   | User Login                     | No                      |\n| `/logout`                  | GET    | User Logout                    | Yes                     |\n| `/refresh-token`           | POST   | Obtain New Access Token        | No                      |\n\n### User Management Routes\n\n| Endpoint                   | Method | Description                    | Authentication Required |\n|----------------------------|--------|--------------------------------|-------------------------|\n| `/update-user`             | PUT    | Update User Details            | Yes                     |\n| `/upload-avatar`           | PUT    | Upload User Avatar             | Yes                     |\n| `/user-details`            | GET    | Retrieve User Details          | Yes                     |\n\n### Password Management Routes\n\n| Endpoint                   | Method | Description                    | Authentication Required |\n|----------------------------|--------|--------------------------------|-------------------------|\n| `/forgot-password`         | PUT    | Initiate Password Recovery     | No                      |\n| `/verify-forgot-password-otp` | PUT | Verify Password Reset OTP      | No                      |\n| `/reset-password`          | PUT    | Reset User Password            | No                      |\n\n## Environment Configuration\n\nSet the '.env' file with values for following variables:\n\n```\nFRONTEND_URL=http://localhost:3000\nMONGODB_URI=mongodb://localhost:27017/your_database\n\nSECRET_KEY_ACCESS_TOKEN=random-access-token-secret-key\nSECRET_KEY_REFRESH_TOKEN=random-refresh-token-secret-key\n\nRESEND_API=your-resend-api-key\n\nCLOUDINARY_CLOUD_NAME=your_cloudinary_cloud_name\nCLOUDINARY_API_KEY=your_cloudinary_api_key\nCLOUDINARY_API_SECRET_KEY=your_cloudinary_api_secret\n\n```\n\n## Security Features\n\n- JWT-based authentication\n- Password hashing\n- Email verification\n- OTP-based password reset\n- File upload middleware\n- Authentication middleware\n\n## Customization\n\nThe generated project structure is designed to be easily extensible. You can:\n- Add new routes in `server/routes/`\n- Implement additional controllers in `server/controllers/`\n- Create new middleware in `server/middlewares/`\n- Extend models in `server/models/`\n\n## Contributing\n\nContributions are welcome! Please submit pull requests or open issues on the GitHub repository.\n\n1. Fork the repository\n2. Create your feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a new Pull Request\n\n## Support\n\nFor issues or questions, please file an issue on the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatmaram-kambli%2Fnode-server-setup-npm-package","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatmaram-kambli%2Fnode-server-setup-npm-package","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatmaram-kambli%2Fnode-server-setup-npm-package/lists"}