https://github.com/canarygrapher/manipalplacements

Unofficial Placement information bulletin for Manipal Institute of Technology
https://github.com/canarygrapher/manipalplacements

Last synced: about 1 month ago
JSON representation

Unofficial Placement information bulletin for Manipal Institute of Technology

• Host: GitHub
• URL: https://github.com/canarygrapher/manipalplacements
• Owner: canaryGrapher
• Created: 2021-08-28T19:29:10.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-05T09:38:17.000Z (over 1 year ago)
• Last Synced: 2024-04-21T18:48:53.072Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://manipalplacements.vercel.app/
• Size: 32.1 MB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# ManipalPlacements

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).

![Logo Designs](https://user-images.githubusercontent.com/27415791/155783685-a3bb2380-cce7-4690-aac5-063569398906.jpg)

## Tech Stack and dependencies

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)

















  

## Installation

Refer to the [example.env.local](https://github.com/canaryGrapher/manipalplacements/blob/main/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.

1. Clone the repo on your local system

2. Install the dependencies using `npm install` or `yarn install` commands 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. 

3. Make sure that you have set up the environment variables properly in the `.env.local` file in the root directory.

4. Run the project using the `npm run dev`

## Guide to contribution

Take a look at the [issues](https://github.com/canaryGrapher/manipalplacements/issues)

This guide will be updated soon. I am currently focusing on finishing the designs first.

### Designing

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

## Preview

![Web capture_26-2-2022_1239_manipalplacements vercel app](https://user-images.githubusercontent.com/27415791/155782348-09f70505-2731-4554-a8f2-3c290677154e.jpeg)