Skip to content
/ nxan-template Public template

Nx mono repo with nestjs apis and angular clients

License

Notifications You must be signed in to change notification settings

kornect/nxan-template

Repository files navigation

logo

Nxan Template

Awesome nx mono repo with NestJS APIs and Angular client!

contributors last update forks stars open issues Version Maintenance License: MIT


📔 Table of Contents

🌟 About the Project

This project is built to provide a template of a mono repo with a NestJS API and an Angular client. Please feel free to use it for your own projects. If you have any questions, feel free to open an issue or contact me.

👾 Tech Stack

The project is in a mono repo implemented using nx:

Client
Server

🧰 Getting Started

‼️ Prerequisites

This project uses npm as package manager, you will need to install it first. Docker is also required to run the database, redis and other services.

⚙️ Installation

Clone the project

  git clone https://github.com/kornect/nxan-template.git

Go to the project directory and install dependencies

  cd nxan-template
  npm install

Setup the environment variables

  cd apps/api
  
  cp .env.example .env # then populate the variables in `.env` file accordingly

Compose the docker containers for the database, redis and other services

  cd apps/api
  
  docker-compose up -d

Start the api server

  npm run start:api

Start the client server

  npm run start:client

🧪 Running Tests

To run tests, run the following command

  nx test

🧭 Roadmap

  • Auth Feature - Login, Register, Forgot Password, Reset Password, etc.
  • User Management Feature

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

⚠️ License

Copyright © 2023 Kornect.
This project is MIT licensed.

🤝 Contact

💎 Acknowledgements

Thanks to the following projects that made this project possible:

About

Nx mono repo with nestjs apis and angular clients

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages