{"id":8024,"date":"2024-07-13T21:17:35","date_gmt":"2024-07-13T15:47:35","guid":{"rendered":"https:\/\/pheonixsolutions.com\/blog\/?p=8024"},"modified":"2024-09-25T16:54:47","modified_gmt":"2024-09-25T11:24:47","slug":"building-a-project-with-nodejs-typescript-express-graphql-and-mongodb","status":"publish","type":"post","link":"https:\/\/pheonixsolutions.com\/blog\/building-a-project-with-nodejs-typescript-express-graphql-and-mongodb\/","title":{"rendered":"1. Building a Project with NodeJs, Typescript, Express, GraphQL and MongoDB"},"content":{"rendered":"\n

<\/p>\n\n\n\n

Creating Node project with Express, MongoDB, Typescript & GraphQL <\/u><\/strong>involves several steps. Lets discuss them in detail as follows:
Prerequisites:<\/strong>
Before getting into the steps to create a node project, let’s make sure the system is installed with node , VS Code, and Mongo DB softwares.
<\/u>
Step 1 : Create the server folder and navigate into it.
<\/strong>mkdir server
cd server<\/p>\n\n\n\n

Step 2: Initialize the project
<\/strong>yarn init -y

Step-3 : Install all packages with typescript dependencies
<\/strong>yarn add express graphql express-graphql mongoose dotenv mongodb cors<\/p>\n\n\n\n

yarn add typescript ts-node @types\/node @types\/express @types\/graphql @types\/mongoose @types\/dotenv  @types\/mongodb -D

Step 4: Setup config.ts file in the project root folder:
<\/strong>{<\/p>\n\n\n\n

  “compilerOptions”: {<\/p>\n\n\n\n

    “target”: “ES6”,<\/p>\n\n\n\n

    “module”: “commonjs”,<\/p>\n\n\n\n

    “strict”: true,<\/p>\n\n\n\n

    “esModuleInterop”: true,<\/p>\n\n\n\n

    “skipLibCheck”: true,<\/p>\n\n\n\n

    “forceConsistentCasingInFileNames”: true,<\/p>\n\n\n\n

    “outDir”: “.\/dist”,<\/p>\n\n\n\n

    “rootDir”: “.\/src”<\/p>\n\n\n\n

  },<\/p>\n\n\n\n

  “include”: [“src”],<\/p>\n\n\n\n

  “exclude”: [“node_modules”]<\/p>\n\n\n\n

}


Step 5: Setup .env file in the project root folder
<\/strong>MONGO_URI=mongodb:\/\/localhost:27017\/mydatabase<\/p>\n\n\n\n

PORT=4000

Step 6: Create folders & files under the project root
<\/strong>mkdir src<\/p>\n\n\n\n

touch src\/index.ts src\/database.ts src\/schema.ts src\/models\/User.ts

Step 7: create database.ts file for DB connection

<\/strong>import express from 'express';<\/pre>\n\n\n\n
import dotenv from 'dotenv';<\/pre>\n\n\n\n
import connectDB from '.\/database';<\/pre>\n\n\n\n
dotenv.config();<\/pre>\n\n\n\n
const app = express();<\/pre>\n\n\n\n
const port = process.env.PORT || 4000;<\/pre>\n\n\n\n
connectDB();<\/pre>\n\n\n\n
app.listen(port, () => {<\/pre>\n\n\n\n
  console.log(`Server is running at http:\/\/localhost:${port}\/graphql`);<\/pre>\n\n\n\n
});

Step 8: Update package.json<\/strong>

\u00a0 \"scripts\": {<\/pre>\n\n\n\n
    “start”: “nodemon –exec ts-node src\/index.ts”,<\/p>\n\n\n\n
    “build”: “tsc”,<\/p>\n\n\n\n
    “test”: “jest”<\/p>\n\n\n\n
\u00a0 },
Step 9:  Create models, schemas, resolvers and update them in index.ts file:
<\/strong>import express from “express”;<\/p>\n\n\n\n
import dotenv from “dotenv”;<\/p>\n\n\n\n
import connectDB from “.\/databse”;<\/p>\n\n\n\n
import { ApolloServer } from “apollo-server-express”;<\/p>\n\n\n\n
import usertypeDefs from “.\/schema\/userschema”;<\/p>\n\n\n\n
import userresolvers from “.\/resolvers\/userResolvers”;<\/p>\n\n\n\n
import UserModel from “.\/models\/usermodel”;<\/p>\n\n\n\n
dotenv.config();<\/p>\n\n\n\n
connectDB();<\/p>\n\n\n\n
const startServer = async () => {<\/p>\n\n\n\n
  const app = express();<\/p>\n\n\n\n
  const server = new ApolloServer({<\/p>\n\n\n\n
    typeDefs: [usertypeDefs],<\/p>\n\n\n\n
    resolvers: [userresolvers],<\/p>\n\n\n\n
    context: {<\/p>\n\n\n\n
      UserModel,<\/p>\n\n\n\n
    },<\/p>\n\n\n\n
  });<\/p>\n\n\n\n
  await server.start();<\/p>\n\n\n\n
  server.applyMiddleware({ app });<\/p>\n\n\n\n
  var PORT = process.env.PORT;<\/p>\n\n\n\n
  app.listen(PORT, () => {<\/p>\n\n\n\n
    console.log(`Server running at http:\/\/localhost:${PORT}`);<\/p>\n\n\n\n
  });<\/p>\n\n\n\n
};<\/p>\n\n\n\n
startServer();<\/p>\n\n\n\n
Step 10:<\/strong> Run the project
<\/strong>yarn start<\/p>\n\n\n\n
Hence, the project gets started and we could see the mongodb connection and server running on port in the console message.
<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"
Creating Node project with Express, MongoDB, Typescript & GraphQL involves several steps. Lets discuss them in detail as follows:Prerequisites:Before getting […]<\/p>\n","protected":false},"author":503,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[1022],"tags":[],"class_list":["post-8024","post","type-post","status-publish","format-standard","hentry","category-web-architecture","psol-cat-web-architecture"],"jetpack_publicize_connections":[],"jetpack_shortlink":"https:\/\/wp.me\/phn2x7-25q","jetpack_sharing_enabled":true,"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/8024","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/users\/503"}],"replies":[{"embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/comments?post=8024"}],"version-history":[{"count":0,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/posts\/8024\/revisions"}],"wp:attachment":[{"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/media?parent=8024"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/categories?post=8024"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/pheonixsolutions.com\/blog\/wp-json\/wp\/v2\/tags?post=8024"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}