An open-sourced campus placement catalogue web application to keep a track of all the companies visiting your campus. (Needs to be set up and managed by an admin).
This application is made on the following stack:
- NextJS with TypeScript
- Ant Design
- Tailwind CSS
- SCSS
- Figma (for designs)
- Firebase (for push notifications)
- MongoDB with mongoose
- localForage
- G-Scripts
- Google Forms (for inputting data)
Refer to the example.env.local file for setting up .env.local for your project. Firebase details are not required if you do not want to include push notification feature. This is not required for local setup.
- Clone the repo on your local system
- Install the dependencies using
npm installoryarn installcommands in the the root of your project. Make sure that you are not using yarn version 2.x.x or Berry, because as of September 12, 2021, typescript does not support plug-n-play. - Make sure that you have set up the environment variables properly in the
.env.localfile in the root directory. - Run the project using the
npm run dev
Take a look at the issues This guide will be updated soon. I am currently focusing on finishing the designs first.
View the upcoming designs for the upcoming designs here. Mail the creator for getting edit access to these designs https://www.figma.com/file/upoK6515aLCjWrGuk7pT8C/Manipal-Placement?node-id=0%3A1
