Repository files navigation

It is my attempt to create Clean Architecture based application in Typescript.

IPoster is a simple fictional application that allows users to publish posts.

1. User
2. Post
3. Media

• User -> IPoster

  1. User can createGuest account inIPoster
  2. User can createAuthor account inIPoster

• User -> Media

  1. Author can create ownMedia
  2. Author can edit ownMedia
  3. Author can get ownMedia
  4. Author can get ownMedia list
  5. Author can remove ownMedia

• User -> Post

  1. Author can create own draftPost
  2. Author can edit ownPost
  3. Author can attach an imageMedia to ownPost
  4. Author can publish ownPost
  5. Author can get ownPost
  6. Author can get ownPost list
  7. Author can remove ownPost
  8. Author andGuest can get publishedPost
  9. Author andGuest can get list with publishedPosts

• Docker

  All necessary external services are described in the./docker-compose.local.yml:

  • Rundocker-compose -f docker-compose.local.yaml up -d
  • Stopdocker-compose -f docker-compose.local.yaml stop

  Services:

  1. PostgreSQL -Credentials.
  2. Minio -Credentials.

• Building

  1. Install libraries -npm install
  2. Build application -npm run build

• Configuring

  Configuring is based on the environment variables. All environment variables must be exposed before starting the application.Seeall environment variables.

• Running

  • Start application -npm run start

  • Expose./env/local.app.env and start application -npm run start:local

    API documentation will be available on the endpointGEThttp://localhost:3005/documentation

    
    

    

• Linting

  • npm run lint

• Testing

  • Prepare environment -docker-compose -f docker-compose.test.yaml up -d
  • Run tests -npm run test
  • Run tests with coverage -npm run test:cov

• Libraries checking

  • Show new libraries' versions -npm run lib:check
  • Upgrade libraries' versions -npm run lib:upgrade

• IDE

  • IntelliJ IDEA:

    1. Launch Configuration
    2. Test Configuration

  • Visual Studio Code:

    1. Launch Configuration
    2. Test Configuration