{"id":19195611,"url":"https://github.com/akashanand708/nodeserver_backend","last_synced_at":"2025-05-08T23:31:33.826Z","repository":{"id":143901185,"uuid":"134604152","full_name":"akashanand708/nodeserver_backend","owner":"akashanand708","description":"A complete initial boilerplate for any WEB and MOBILE application to provide REST APIs, written in Node.js and ES6.","archived":false,"fork":false,"pushed_at":"2019-04-18T15:32:56.000Z","size":41,"stargazers_count":12,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-20T09:43:27.965Z","etag":null,"topics":["nodejs","nodejs-modules","nodejs-mysql","nodejs-server"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/akashanand708.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":"2018-05-23T17:29:19.000Z","updated_at":"2024-05-20T01:24:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"76bf9acd-e963-425b-85ab-f80340ea4111","html_url":"https://github.com/akashanand708/nodeserver_backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashanand708%2Fnodeserver_backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashanand708%2Fnodeserver_backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashanand708%2Fnodeserver_backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akashanand708%2Fnodeserver_backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akashanand708","download_url":"https://codeload.github.com/akashanand708/nodeserver_backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253163841,"owners_count":21864144,"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":["nodejs","nodejs-modules","nodejs-mysql","nodejs-server"],"created_at":"2024-11-09T12:10:54.161Z","updated_at":"2025-05-08T23:31:33.815Z","avatar_url":"https://github.com/akashanand708.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NODESEVER-BACKEND-BOILERPLATE\n\n\u003e A complete initial boilerplate for any WEB and MOBILE application to provide REST APIs, written in Node.js and ES6.\n\n# Key features\n## 1. API exposed\n- /api/v1/register         -For signUp.\n- /api/v1/login            -For logIn.\n- /api/v1/logout           -For logOut.\n- /api/v1/resetPassword    -For reset password.\n- /api/v1/updatePassword   -For update password.\n\n## 2. Introduced Prisma which support MySQL, PostgreSQL, MongoDB.\n\n## 3. Proper error handling.\n\n## 4. Nodemailer implemented for Reset Password.\n\n## 5.For encryption/decryption, methods have been written in CRYPT.JS\n\n## 6.All APIs can be seen in SWAGGER DOCS on http://localhost:5001/api-docs/\n\n# Swagger configuration\n- After starting the server in development mode swagger can be run with this url.\n  http://localhost:5001/api-docs/\n\n- After adding any new API, need to update SWAGGER.js for that API.\n\n\n# Requirements\nTo start any WEB or MOBILE application, we need complete package of REST APIs\nlike signup/login/logout/resetPassword/UpdatePassword.\nThis boilerplate can be used.\n\n# Dependencies\n\n- Watcher and hot-reload: [nodemon](http://nodemon.io/)\n- Build: [babel](http://babeljs.io/)\n    + tools: babel-cli, babel-core\n    + presets: babel-preset-es2015-node6, babel-preset-stage-3\n- Deployment: [PM2](https://github.com/Unitech/pm2)\n- Tech Stack: \n\n# Logger implemented\n# Build Setup\n\n``` bash \n# install dependencies\nnpm install\n\n# run for development with hot reload at localhost:5001\nnpm start\n\n# build for production\nnpm run build\n\n# run for production.\nnpm run serve\n\n# run for test\nnpm run test\n```\n\n# Mailer service configuration\n- Copy env file to .env\n- Write necessary mailer service information.\n\n# To connect to database, need to start prisma server.Below is the prisma configuration\n\n# Prisma configuration\n``` bash\n# Install the Prisma CLI\nbrew install prisma\n\n# Install Docker\nTo use Prisma locally, you need to have Docker installed on your machine. If you don\\'t have Docker yet, you can download the Docker Community Edition for your operating system here.\nhttps://www.docker.com/products/docker-engine\n\n```\n\n## 1. Prisma setup for new data-base\n### 1. Make new folder\n``` bash\n# Set up and connect Prisma with a database\nmkdir hello-world\ncd hello-world\n\n# Create Docker Compose file\nTo launch Prisma on your machine, you need a Docker Compose file that configures Prisma and specifies the database it can connect to.\ntouch docker-compose.yml\n\n# Add Prisma and database Docker images\nPaste the following contents into the Docker Compose file you just created: for MongoDB\n\nversion: '3'\nservices:\n  prisma:\n    image: prismagraphql/prisma:1.30\n    restart: always\n    ports:\n    - \"4466:4466\"\n    environment:\n      PRISMA_CONFIG: |\n        port: 4466\n        databases:\n          default:\n            connector: mongo\n            uri: mongodb://prisma:prisma@mongo\n  mongo:\n    image: mongo:3.6\n    restart: always\n    environment:\n      MONGO_INITDB_ROOT_USERNAME: prisma\n      MONGO_INITDB_ROOT_PASSWORD: prisma\n    ports:\n      - \"27017:27017\"\n    volumes:\n      - mongo:/var/lib/mongo\nvolumes:\n  mongo:\n\n# Launch Prisma and the connected database\ndocker-compose up -d\n\n```\n\n### 2. Configure your Prisma API\nTo bootstrap the configuration files for your Prisma client run the following command:\nprisma init --endpoint http://localhost:4466\nThe endpoint needs to match the URL of a running Prisma server.\n\n### 3. Deploy the Prisma datamodel\nThe prisma init command created the minimal setup needed to deploy the Prisma datamodel: prisma.yml and datamodel.prisma.\nprisma deploy\n\n### 4. View and edit your data in Prisma Admin\nIf you want to view and edit the data in your database, you can use Prisma Admin. To access Prisma Admin, you need to append /_admin to your Prisma endpoint, for example: http://localhost:4466/_admin.\n\n### 5. Generate your Prisma client\nThe Prisma client is a custom, auto-generated library that connects to your Prisma API. Append the following lines to the end of your prisma.yml:\nprisma generate\n\n## 2. Prisma setup for existing data-base\n### 1. https://www.prisma.io/docs/get-started/01-setting-up-prisma-existing-database-JAVASCRIPT-a003/\n``` bash\nprisma init hello-world\n```\n1. This launches an interactive wizard. Here\\'s what you need to do:\n2. Select Use existing database\n3. Select your database, either PostgreSQL or MongoDB\n4. Provide the connection details for your database (see below for more info)\n5. Select the Prisma JavaScript client\n\n### 2. Launch Prisma\n``` bash\ncd hello-world\ndocker-compose up -d\n```\n\n### 3. Deploy the Prisma datamodel\nprisma deploy\n\n\n## 3. Process when you need to update databasemodel.prisma\n1. Update databasemodel.prisma\n2. docker-compose up -d (Start server if not started)\n3. prisma deploy\n4. prisma generate (To generate prisma client plug in) ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashanand708%2Fnodeserver_backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakashanand708%2Fnodeserver_backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakashanand708%2Fnodeserver_backend/lists"}