Skip to content

README.md

Latest commit

 

History

History
65 lines (44 loc) · 1.45 KB

README.md

File metadata and controls

65 lines (44 loc) · 1.45 KB

TypeScript API example

About 📖

An example on how to create and organize your API build with the ExpressJS framework and TypeScript.

Run locally 🚀

Prerequisites 📋

  • NodeJS
  • MongoDB (Optional, if you want to run the database locally)
  • Yarn (Optional, if you want to use Yarn instead of NPM)
  • Postman (Optional, if you want to test the API)
  • MySQL (Optional, if you want to run the database locally)

Installation 🔧

The first step is cloning the repository on your local machine. The will create a new folder which includes the source from the repository.

git clone https://github.com/HalloSouf/api-example

Navigate through your CLI to the directory which is created by the previous command.

cd api-example

Install the required dependencies listed in the package.json file.

npm install
# Or
yarn install

Start the application by running the dev command.

npm run dev
# Or
yarn dev

Build application 🧱

To build the application, run the build command.

npm run build
# Or
yarn build

When the build is completed, you can run the application by running the following command.

node build/main.js

License 📄

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.md file for details