pr0pm / tnpw

Training and Placement Cell Website

A website for Training and Placement Cell, Faculty of Engineering and Technology, University of Lucknow.


View Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

About The Project

This project is a website for Training and Placement Cell of Faculty of Engineering and Technology, Lucknow University.

Features:

• Showcase the 100+ years legacy of University and achievements by students of FoET under the guidance of Training and Placement Cell.
• Allows recruiters to filter, search, sort the student details according to their needs and export it as PDF or CSV.
• Enable students to add their details only once instead of filling google forms for every new recruiter.

Built With

• MongoDB
• Express
• React
• Node
• React-Bootstrap

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Prerequisites

To contribute/extend to this project it is recommended to have an understanding of following:

• JavaScript
• MERN Stack(MongoDB, Express, React JS, Node.js)
• Bootstrap
• Git
• JWT

Setting up Local Development Environment

1. Fork the Project

git clone [email protected]:<your_github_username>/tnpw.git

2. Generate your Mongo URI from https://mongodb.com and create a .env in root with the following content.

MONGO_URI = <PUT_MONGO_URI_HERE>

3. Follow these commands to install all the dependencies and start the development server on your local machine.

  cd tnpw
  npm install
  cd frontend
  npm install
  cd ..
  npm run dev

4. Create your Feature Branch (git checkout -b feature/AmazingFeature)

5. Commit your Changes (git commit -m 'Add some AmazingFeature')

6. Push to the Branch (git push origin feature/AmazingFeature)

7. Open a Pull Request

Roadmap

See the open issues for a list of proposed features (and known issues).

License

Distributed under the AGPLv3 License. See LICENSE for more information.

Contact

Your Name - Arjun Dubey - [email protected]