/frozenpants-bkn

A Instagram clone that Jonathan, Marius and I work/-ed on through 4 Modules.

Primary LanguageTypeScriptMIT LicenseMIT

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

Description

The backend of a Instagram clone that Jonathan Jost, Marius Hummel and I work/-ed on through 4 Modules.

The frontend part can be found here.

Installation

$ yarn install

Documentation

A documentation can be generated locally by running either of the following commands.

# Build documentation
# available in docs/index.html
$ yarn doc:build

# Build and serve documentation
# available on localhost:8080
$ yarn doc:serve

Setup

Duplicate .env.example and ormconfig.example.json. Rename them to .env and ormconfig.json respectively. Then enter the sensitive data.

Make sure to not modify or delete the original files.

Then run $ yarn typeorm:run to setup the database.

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Typeorm

# shortend command for typeorm cli
$ yarn typeorm

# create a new migration
$ yarn typeorm:migrate yourMigrationName

# migrate migration files to db
$ yarn typeorm:run

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

License

Nest and Frozenpants are both MIT licensed.