Overview:
The Bunk Manager Mern project offers two methods for installation: the conventional way and using Docker. It provides detailed guidelines for contributing to the project, including cloning, making changes, and creating pull requests. Additionally, the project includes prototypes for various pages like Landing Page, Login Page, Sign Up Page, About Us Page, Today Page, and Subject Details Page.
Features:
- Installation Options: Supports both conventional installation and installation using Docker.
- Contributing Guidelines: Detailed instructions for contributing to the project, including forking, cloning, making changes, and creating pull requests.
- Prototypes: Provides prototypes for various pages of the project like Landing, Login, Sign Up, About Us, Today, and Subject Details Pages.
Installation:
Conventional Way:
- Open Project Folder.
- To install all dependencies, open Command Prompt and run.
- To install all client dependencies, open the client folder and run.
- To run the server.
- To run the client.
- To run both server and client (Recommended).
Using Docker:
- Install Docker.
- Use the following commands to run the app in the root directory:
docker-compose build(to build the project).COMPOSE_HTTP_TIMEOUT=200 docker-compose up(to run the container).
- Access the project on localhost:3000.
Summary:
The Bunk Manager Mern project offers two installation methods, detailed guidelines for contributing, and provides prototypes for various pages. Users can choose between the conventional way or use Docker for installation. The project aims to simplify the process of contributing by providing step-by-step instructions for forking, cloning, making changes, and creating pull requests.