Overview:

The RBAC MERN Boilerplate project is a complete MERN (MongoDB, Express.js, React.js, and Node.js) boilerplate repository that incorporates RBAC (Role-Based Access Control) feature and follows production best practices. The project aims to provide a solid foundation for building MERN applications and includes a variety of technologies and packages for both the client and server sides.

Features:

• RBAC (Role-Based Access Control) feature for managing user roles and permissions
• Ant Design Pro for an improved user interface experience
• Testing Library and Jest for JavaScript testing
• Umi Request for HTTP client functionality
• Docker support for easy deployment
• MongoDB, Express.js, and React.js as the core technologies

Installation:

To install and run the RBAC MERN Boilerplate project, follow these steps:

1. Clone the repository to your local machine:

git clone [repository-url]

2. Navigate to the root of the repository.

3. Choose one of the following options to run the application:

• Docker:

  • Depending on your MongoDB hosting option, choose the appropriate docker-compose file:
    • docker-compose.mongocloud.yml - for MongoDB.com hosted cluster
    • docker-compose.yml - for local MongoDB container
  • If necessary, update the MONGODB_CLOUD_URL in docker-compose.mongocloud.yml to the appropriate MongoDB URL.
  • If necessary, update the REACT_APP_API_URL in docker-compose.yml to the appropriate API URL.
  • Run the appropriate docker-compose command to spin up the server, client, and MongoDB containers:

  docker-compose -f [docker-compose-file] up
  

• Manual via VSCode:

  • Make sure you have Docker and Docker Compose installed on your machine.
  • Open the repository in VSCode.
  • Run the appropriate commands in the integrated terminal:

  docker-compose -f [docker-compose-file] up
  

4. Once the containers are up and running, you should be able to access the application by navigating to the specified client URL.

Summary:

The RBAC MERN Boilerplate project is a comprehensive MERN boilerplate that includes RBAC functionality, follows production best practices, and utilizes various technologies and packages such as Ant Design Pro, Umi Request, and Docker. It provides a solid foundation for developing MERN applications with role-based access control and offers an improved user interface experience. The project can be easily installed and run either through Docker or manually using VSCode.