Skip to content

niksbanna/adminjs-nestjs-example-app

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Coverage Discord Backers on Open Collective Sponsors on Open Collective Support us

AdminJS with NestJS and Mongoose Example

This repository serves as a working example of integrating AdminJS with NestJS using Mongoose. AdminJS is a modern admin panel for Node.js applications.

Getting Started

Follow the steps below to set up and run the example:

Prerequisites

Make sure you have the following installed:

  • Node.js and npm
  • MongoDB (Make sure your MongoDB server is running)

Installation

  1. Clone the repository:

    git clone https://github.com/niksbanna/nestjs-adminjs-example-app.git
    
    

Installation

$ yarn install

ENV Configuration

create a .env file and update your database URL

DB_URL=`your_db_url`

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Open for Pull Requests

Feel free to contribute and improve this example! If you have any enhancements, bug fixes, or new features to propose, please follow the guidelines below:

  1. Fork the repository.

  2. Create a new branch for your changes:

    git checkout -b feature/your-feature-name
    git commit -m "Add your commit message here"
    git push origin feature/your-feature-name
    
  3. Open a Pull Request (PR) against the main branch of this repository.

Please provide a clear and descriptive PR title and description. Ensure that your code follows best practices, is well-documented, and includes relevant tests.

Thank you for your contributions! 🚀

About

Example app of using AdminJS library with NestJS

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published