Placemento

This is a project for the MCA students of NIT Warangal College. This project is a web-based application that is used to manage the placement activities of the Batch. This project is developed using the MERN (MongoDB, Express, React, Node) stack. This project is developed by the students of MCA 2021-2024 batch of NIT Warangal College.

File Structure

The file structure of the project is as follows:

Placemento
├── client
│   ├── public
│   └── src
│       ├── api
│       ├── components
│       ├── pages
│       ├── utils
│       ├── App.jsx
│       ├── index.js
│       └── ...
├── server
│   ├── controllers
│   ├── middleware
│   ├── models
│   ├── routes
│   ├── utils
│   ├── index.js
│   └── ...
├── .gitignore
├── package.json
└── ...

Installation

To get started, follow these instructions to install the project on your local machine.

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (v20.0.0 or higher)
• npm (v10.0.0 or higher)

Steps

1. Creating your branch:

   I. For Organization Members:

   • Branch Creation: As an organization member, when working on a new feature or task, you should create a new branch from the "develop" branch. The branch name should be in the format feature- where <description> represents a short description of the task or feature you are working on. For example, if you are adding a login feature, the branch name could be feature-login.
   • Code Implementation: Implement the necessary changes and new features on your created branch. Make sure to adhere to the organization's coding standards and best practices.
   • Code Testing: Thoroughly test your changes on the branch to ensure that they work as expected and do not introduce any bugs or issues.
   • Code Review: If required by the organization's development process, request a code review from your peers to ensure code quality and adherence to project guidelines.
   • Pull Request Creation: Once you are confident that your code is complete and tested, create a pull request to merge your changes from the feature-* branch into the develop branch. Clearly explain the purpose and scope of the changes in the pull request description.

   II. For External Contributors:

   • Forking the Repository: If you are an external contributor, you should fork the repository to your GitHub account. This will create a copy of the repository under your account, which you can use to make changes and submit pull requests.

   • Branch Creation: After forking the repository, create a new branch from the develop branch. The branch name should be in the format feature- where <description> represents a short description of the task or feature you are working on. For example, if you are adding a login feature, the branch name could be feature-login.

   • Code Implementation: Implement the necessary changes and new features on your created branch. Make sure to adhere to the organization's coding standards and best practices.

   • Code Testing: Thoroughly test your changes on the branch to ensure that they work as expected and do not introduce any bugs or issues.

   • Code Review: If required by the organization's development process, request a code review from your peers to ensure code quality and adherence to project guidelines.

   • Pull Request Creation: Once you are confident that your code is complete and tested, create a pull request to merge your changes from the feature-* branch into the develop branch. Clearly explain the purpose and scope of the changes in the pull request description.

2. Clone the repository:

   git clone https://github.com/MCA-NITW/placemento.git

3. Navigate to the project directory:

   cd placemento

4. Install the project dependencies:

   npm install
   npm run fb-install

5. Start the development server:

   npm run dev

6. Open the application in your browser:

   http://localhost:3000

   The application should now be running in your browser.

Contributing

If you would like to contribute to the project, please read the CONTRIBUTING.md file for more information.

License

This project is licensed under the MIT License.

Contact

If you have any questions or need further assistance, please feel free to contact us.

Project Status

The project is currently under development. The initial version of the project is expected to be released soon.

Project Team

The project team consists of the following members:

• Sagar Gupta
• Sachin Gupta

Acknowledgements

We would like to thank the following individuals and organizations for their contributions to the project:

• NIT Warangal College
• MCA 2021-2024 Batch

References

• MERN Stack
• React
• Node.js
• Express
• MongoDB
• AG Grid
• AG Charts
• React-Router
• Axios
• JWT
• Bcrypt
• Mongoose
• Nodemailer
• Dotenv
• Cors
• Nodemon
• Concurrently
• Prettier