Alexius08 / dpaths-api

Nest.js application providing REST API for the corresponding Ionic/Angular PWA

Distilled Paths API

Distilled Paths is a Nest.js application providing REST API for the corresponding Ionic/Angular PWA. It's hooked to PostgreSQL database for data persistence via TypeORM.

Quick Start

1. npm install
2. npm run start:dev¹

¹ You will need to add .env file with necessary environment variables to the root folder when working with the app locally

Project Structure

Obfuscated Environment Variables

You need to create a .env file with the main environment variables required to run this project before starting to work with it:

DB_TYPE=DataBaseType
DB_HOST=DataBaseHostAddress
DB_PORT=DataBasePort
DB_USERNAME=DataBaseUserName
DB_PASSWORD=DataBasePassword
DB_DATABASE=DataBaseName
DP_JWT_SECRET_KEY=YourJwtSecretKeyString
DP_JWT_EXP=JwtExpirationPerion
DP_ADMIN_CODE=AdminSignUpSecretCodeString

Documentation

Swagger API documentation is available under https://.../api

Deployment

The master branch of this respository is automatically deployed to Heroku where it's hosted along with the connected PostgreSQL database. The admin panel is available at https://dashboard.heroku.com/apps/distilled-paths.

Contributing

Thank you for your interest in contributing to Distilled Paths! There are many ways to contribute to this project. Get started here.