AirMan

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Download and install Nodejs
• Download and install PostgreSQL
• A web browser (e.g. Google Chrome, Mozilla Firefox, Microsoft Edge)
• A text editor (e.g. Visual Studio Code, Sublime Text)
• A platform for testing APIs like Postman

Installing

1. Clone the repository to your local machine:

https://github.com/mohamadelhinamy/AirMan.git

2. Install required packages npm install
3. Configure the environment variables, such as the database URL.
4. npm run prisma:migrate
5. npm run build then npm run dev

Folder Structure

• package.json
• .gitignore
• .prettierrc
• tsconfig
• tslint.json
• .env (not committed)
• .env.default (commit it)
• README.md
• src
  • app.ts
  • config.ts
  • index.ts
  • routes
    • [routeFileName].ts
    • index.ts
  • modules
    • [module name]
      • repos
        • [moduleNameRepo].ts
      • services
        • [moduleNameService].ts
      • interface
        • [IModuleName].ts
      • index.ts (In which you export your modules' services)
  • database
    • Prisma
      • migrations
      • schema.prisma
    • client.ts
  • core
    • route.ts

Tools & Technologies

• TypeScript
• Nodejs
  • Express.js
• PostgreSQL
• Prisma (ORM)