Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raza-liv/2024-react-nest-monorepo
[React.js] + [Nest.js] + [MongoDB] Boilerplate to setup project quickly. Vite is used as a fromtend builder. Project have shared eslint configuration as well as tsconfig. Also, there are some scripts to work with versioning and packages
https://github.com/raza-liv/2024-react-nest-monorepo
boilerplate mongo nest react
Last synced: 29 days ago
JSON representation
[React.js] + [Nest.js] + [MongoDB] Boilerplate to setup project quickly. Vite is used as a fromtend builder. Project have shared eslint configuration as well as tsconfig. Also, there are some scripts to work with versioning and packages
- Host: GitHub
- URL: https://github.com/raza-liv/2024-react-nest-monorepo
- Owner: Raza-LIV
- License: mit
- Created: 2024-10-18T19:43:13.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T10:08:36.000Z (about 1 month ago)
- Last Synced: 2024-12-16T16:58:39.821Z (29 days ago)
- Topics: boilerplate, mongo, nest, react
- Language: TypeScript
- Homepage:
- Size: 743 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React.js + Nest.js + MongoBD
## Project overview
-Placeholder-
## How to start
Initially, project is build on `Node` version `22.5.1` and `Yarn` version `4.5.0`.
To install all necessary dependencies just run:
```bash
yarn install
```
## Backend
The backend is developed using NestJS, following best practices and patterns recommended in the official [NestJS documentation](https://docs.nestjs.com). This ensures a modular and maintainable structure for scalable applications.
The application runs by default on port `4200`, but this can be modified according to your needs by configuring the environment variables.
Environment Variables
Environment-specific settings are managed using `.env` files. All crucial configuration values such as database credentials, API keys, and other sensitive information should be defined within the `.env` file located at the root of the project. The default environment is considered to be the development environment.
For more specific environments like staging or production, separate configuration files such as `.env.staging` or `.env.production` should be created and utilized. This helps in cleanly separating environment configurations and ensuring that sensitive production variables are not mixed with development configurations. The backend uses MongoDB as the primary database, document-oriented database known for its scalability and flexibility.
Additionally, make sure that these environment files are appropriately handled and excluded from version control by adding them to your `.gitignore` file, thus preventing sensitive data from being exposed in the repository.
## Frontend
The frontend is developed using `React` with `TypeScript`, providing a strong foundation for building maintainable and scalable applications. To enhance the development experience, Vite is used as the build tool, offering fast bundling and hot module replacement (HMR) for seamless development workflows.
The project is structured following the [Feature-Sliced Design (FSD) methodology](https://feature-sliced.design/docs/get-started/overview). This architectural pattern is focused on dividing the codebase by features, ensuring that each feature remains independent and modular. FSD promotes better scalability, separation of concerns, and maintainability as the application grows.
The frontend is pre-configured with [Vite](https://vite.dev) default setup, enabling fast builds and minimal configuration. The project structure is optimized for maintainability and growth, aligning with the principles of FSD to ensure a well-organized and scalable application.