Miracle

This is a miracle project. Use Nodejs, Nx, Nextjs, Nestjs, Angular, etc.

Getting Start

Installing core dependencies

Before we start, we need to install:

• nodejs

Make sure we don't get any error after installation

Open our terminal and follow this instruction

Check NodeJs is successful installed in our OS.

node --version

# will return
# v20.10.0

Run with Docker

1. We need to install docker and docker compose.

• Docker official Documentation, here
• Docker Compose official Documentation, here

2. Check docker is running or not

docker --version

# will return
# Docker version 24.0.7, build afdd53b

and check docker-compose

docker-compose --version

# will return
# Docker Compose version v2.23.3-desktop.2

3. Run docker compose

docker-compose up -d

Running the project

These instructions should be sufficient for one to get the project going on their local machine

Cloning the github repository

To clone the project, run

git clone https://github.com/jiayisheji/miracle.git

Installing the dependencies

To install the dependencies after you've cloned the project, go to its root folder and run

cd miracle && pnpm install --frozen-lockfile

Setting environment variables

cp .env.example  .env

Alternative commands

If you need to work on the client, you can run

pnpm exec nx serve webapp

Then, you can go to the Angular dev server at port 4200 and test server requests (to port 3000), we got a proxy to the backend

If you only need to work on the frontend, you can run

pnpm exec nx serve admin

Alternatively, if you only need to work on the backend, you can run

pnpm exec nx serve api

Reference

1. Awesome Nest

• https://github.com/juliandavidmr/awesome-nest

2. Awesome Next

• https://github.com/unicodeveloper/awesome-nextjs

3. Awesome Angular

• https://github.com/PatrickJS/awesome-angular

4. Awesome Nx

• https://github.com/nrwl/nx-examples

back to top