OpenAPI

https://planwear-backend.herokuapp.com/api/

Description

Rest API application for PlanWEAR (Manage appointments & organize schedules), build in Nest framework.

Database Structure

Work in progress - nothing final yet, nightly tweaks are made!!! Diagram may not represent current entities model.

Current status

Work in progress - pre-alpha stage!!!

External services

PlanWEAR application will be used Twilio external communication API as SMS provider. The following environmental variables are required:

• TWILIO_ACCOUNT_SID
• TWILIO_AUTH_TOKEN

If you don't want register Twilio account right now, you may want to remove/comment following block of code in src/app.module.ts:

    TwilioModule.forRootAsync({
      useFactory: (configService: ConfigService) => ({
        accountSid: configService.get('TWILIO_ACCOUNT_SID'),
        authToken: configService.get('TWILIO_AUTH_TOKEN'),
      }),
      inject: [ConfigService],
    }),

Important: Twilio credentials, while not neccessary needed at the moment, will be required in near future.

Entities

[x] Abstract (extends other entities with id [uuid], createdAt & updatedAt fields)
[x] Appointment
[x] Article
[x] BillingAddress
[x] Comment
[x] Company
[x] Country
[x] Event
[x] Photo
[x] ProductCategory
[x] Product
[x] Schedule
[x] ServiceCategory
[x] ServicesBooked
[x] ServicesProvided
[x] Service
[x] Tag
[x] Token
[x] User

Migrations

Not set-up yet, work in progress. TypeORM synchronize option is set to true - development mode ONLY, not suited for production!!!

Installation

$ npm install

Docker

$ docker-compose up -d

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Stay in touch

• Author - [email protected]