Git Product home page Git Product logo

nodejs-api-typescript's Introduction

NODE.JS API STARTER WITH TYPESCRIPT

Description: A starter project for building Node.js APIs with TypeScript, Express, MongoDB, Mongoose.

How To Use

1. From your command line, first clone this repository:

git clone https://github.com/watat83/nodejs-api-typescript.git

Then you can install the dependencies using npm or yarn:

npm install or yarn install

2. Rename .env.example file in the root directory to .env and replace the string YOUR_MONGODB_ATLAS_URL with your own MongoDB Atlas URL:

MONGODB_ATLAS_URL=<YOUR_MONGODB_ATLAS_URL>

3. Run the development server:

npm run test / npm run dev / npm run prod

The command will execute one of the following scripts:

"test": "ts-node ./app/server.ts", or

"dev": "tsc && nodemon ./dist/server.js", or

"prod": "tsc && nodemon ./dist/server.js",

The command will

  • Run the typescript compiler (ts-node / tsc),
  • Create a ./dist folder that will store all the compiled JavaScript files,
  • Compile all the .ts files from ./app folder into .js files in the ./dist folder. See config instructions in the tsconfig.json file, compilerOptions{}.
  • Run the server.ts or server.js file to launch the server on the appropriate port.

4. Open http://localhost:<PORT_SPECIFIED> with your browser to see the result.


(c) 2022 by Chris Nzouat - All rights reserved.

Licensed under MIT

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.