This project is organized as a monorepo using Turborepo. The monorepo contains multiple applications and libraries, which are managed in a single repository. This allows for better code sharing and easier management of dependencies.
The project is divided into two main parts:
- Remix Application: This is the frontend application built using Remix. It handles the client-side rendering and routing.
- NestJS Application: This is the backend application built using NestJS. It provides the API endpoints and handles server-side logic.
To get started with the project, follow these steps:
-
Clone the repository:
git clone https://github.com/mrglox/remix-nest-boilerplate.git cd remix-nest-boilerplate
-
Install dependencies:
npm install
-
Set up environment variables: Create a
.env
file in the root directory and add the necessary environment variables. Refer to the.env.example
file for the required variables.
To start the project, follow these steps:
-
Build the project:
npm run build
-
Start the development server:
npm run dev
-
Access the application: Open your browser and navigate to
http://localhost:3000
to access the Remix application. The NestJS API will be running athttp://localhost:4000
.
-
Lint the code:
npm run lint
-
Run tests:
npm run test
-
Format the code:
npm run format
// ...existing code...