nestjs-admin

(โ˜… 553)

A generic administration interface for TypeORM entities

  • .dockerignore
  • .env.mysql
  • .env.postgres
  • .env.test
  • .gitignore
  • .prettierrc
  • docker-compose.yml
  • Dockerfile
  • ex.ts
  • LICENSE
  • package.json
  • README.md
  • tsconfig.build.json
  • tsconfig.json
  • tslint.json
  • yarn.lock

๐Ÿš€ Installation Guide

1. Get the code
git clone https://github.com/Theodo-UK/nestjs-admin

Downloads the entire project code from GitHub to your computer.

cd nestjs-admin

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker-compose up

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn add nestjs-admin # With yarn

Type this command into your terminal and run it.

npm install nestjs-admin # With NPM

Downloads and installs the libraries listed in package.json.

yarn install

Downloads and installs the libraries listed in package.json.

yarn link

Type this command into your terminal and run it.

yarn start:dev

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation