Tech Stack

Other Libraries

How To Run the Project

There are two ways to install the project:

1. Conventional Way

1. Open Project Folder
2. To install all dependencies, open Command Prompt and run npm i
3. To install all client dependencies, open the client folder and again run npm i
4. To run the server, use npm run server
5. To run the client, use npm run client
6. To run both server and client (Recommended), use npm run dev

2. Using Docker

Follow these steps to run the app using Docker:

• Install Docker from the given link.
• Once Docker is installed, use the following two commands to run the app in the root directory:
• docker-compose build – This command will build the project
• COMPOSE_HTTP_TIMEOUT=200 docker-compose up – This command will run the container
• You can open the project on localhost:3000 on the machine.

Note: If you are using Docker Desktop on Windows or WSL2 (Windows Subsystem For Linux), you can use the GUI Options to run the containers.

Contributing to the Project

To start contributing to Bunk Manager, follow these guidelines:

1. Fork this repository.
2. Clone your forked copy of the project: git clone --depth 1 https:github.comyour_user_namebunk-manager-mern.git
3. Navigate to the project directory: cd bunk-manager-mern
4. Add a reference (remote) to the original repository: git remote add upstream https:github.comADRE9bunk-manager-mern.git
5. Check the remotes for this repository: git remote -v
6. Always take a pull from the upstream repository to keep your master branch updated: git pull upstream master
7. Create a new branch: git checkout -b your_branch_name
8. Perform your desired changes to the code base.
9. Track your changes: git add .
10. Commit your changes: git commit -m "Relevant message"
11. Push the committed changes to your remote repo: git push -u origin your_branch_name
12. To create a pull request, click on compare and pull requests. Ensure you compare your feature branch to the desired branch of the repo you intend to PR to.
13. Add an appropriate title and description to your pull request explaining your changes and efforts.
14. Click on Create Pull Request.

Prototypes

Here are links to the prototypes for various pages of the application:

• Landing Page Mockup
• App Prototype
• Login Page Prototype
• Sign Up Page Prototype
• About Us Page Prototype
• Today Page Prototype
• Subject Details Page Prototype

Troubleshooting Ideas

Should you encounter any challenges while running the Bunk Manager project, here are a few helpful troubleshooting ideas:

• Make sure you have all necessary software installed, such as Node.js, MongoDB, and Docker if you are using that method.
• If you can’t see the project running on localhost:3000, double-check your terminal for any error messages and ensure the server is started.
• For conflicts in repository updates, ensure you frequently pull the latest changes from the upstream repository.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.