cdc-placement-website-frontend's Introduction

Frontend Repo for CDC Placement Website

Folder Structure

.src
├── Student                   # Files related to Student portal
│   ├── api                   # APIs for fetching dashboard, profile and submitting job-application form
│   ├── components            # Student Portal components
│   ├── images 
│   └── App.js                # Main App for Student portal
├── Admin                       # To be created...
│   ├── api                   
│   ├── components           
│   ├── images 
│   └── App.js                # Main App for Admin portal
├── api
│   └── auth.js               # API for sign-in
├── components                # Website wide used components
├── images                    
├── utils                     # Tools and utilities
├── App.js                    # Main App for the whole web-application
├── index.css
└── index.js

Getting Started

Quick Start

Fork it :

Get your own Fork/Copy of repository by clicking Fork button right upper corner

Clone:

$ git clone https://github.com/CDC-IITDH/cdc-placement-website-frontend.git
$ cd cdc-placement-website-frontend

Branching

$ git checkout -b [your_branch_name]

Setting up Project

Install and setup NodeJS. To check, running node -v on terminal should give a number like `v15.14.0

$ npm i
$ npm start

See the running application at http://localhost:3000/ after running this command

NOTE To sign-in and start using the web-application you'll need React-Login API secret key and your email verified by the backend. Please show your interest in contributing by sharing your email-id on Github-issue(#9) and we will share the keys and get your email verified.

Recommend Projects