College Metrics

College metrics dashboard.
Check backend here: https://github.com/tirthajyoti-ghosh/college-metrics-backend.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A Single Page responsive dashboard application to show various metrics and list of colleges and its students.

Features:

• Vector world map displays colleges in various countries.
• Donut chart displays colleges offering various courses.
• Tables displays list of students and colleges
• Each row in student table expands to show their details.
• Clicking on each row in college table opens the college details section.
• College details section contains details about the college list of students and list of similar colleges.

Built With

• React
• Redux
• SCSS
• Ant Design
• ApexCharts
• ESLint
• Stylelint
• Netlify

Live demo

Deployed to Netlify - live demo.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/tirthajyoti-ghosh/college-metrics-frontend.git

2. Change directory

   cd college-metrics-frontend

3. Install NPM packages

   npm install

4. Start the local server

   npm start

Roadmap

Check the issues.

Contributing

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

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Contact

👤 Tirthajyoti Ghosh

• Website: ghosh.tech
• GitHub - @tirthajyoti-ghosh
• Twitter - @terrific_ghosh
• LinkedIn - @tirthajyoti-ghosh

Acknowledgements

• Design inspirations
  • Netflix-Redesign-challenge-on-Uplabs
  • Netflix-Redesign-Idea
• README icon by Icons8
• Img Shields
• Font Awesome