yangxdev / nextjs-dashboard

💼 A successful take-home project I made for a job interview

Home Page:https://nextjs-dashboard-yangxdev.vercel.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tech Company Frontend Challenge

Disclaimer: the original name of the company has been anonymized, we'll call them "TC" from now on!

Welcome to my frontend challenge! This project will cover the main features and functionalities shown in the example design given by TC. The work has been previously done in the 'develop' branch of a private repository, with clear commit titles and a proper development order, starting from project initialization with Next.js, to a setup of the main variables, and thus developing each component. The work is then merged on the 'main' branch, ready to be tested and analyzed by others. The project has since been moved to a personal public repository, in the 'main' branch.

Preview

Website preview

Table of Contents

Installation

To get this project up and running on your local machine, follow these steps:

  1. Clone the Repository:
    git clone https://github.com/yangxdev/nextjs-dashboard.git
    
  2. Navigate to the Project Folder:
    cd nextjs-dashboard
    
  3. Install Dependencies: Use npm to install the required dependencies.
    npm install
    
    If you prefer using yarn:
    yarn install
    
  4. Start the Development Server: Run the development server to view the project in your browser.
    npm run dev
    
    or with yarn:
    yarn dev
    
  5. Open in Your Browser: Once the development server is running, open your browser and go to http://localhost:3000 to see the project in action. Now you have the project set up locally, and you can explore it, make modifications, and test it in your development environment.

Usage

This demo project lets the user navigate through the left-side routing menu panel, showing each option's content on the right-side panel, currently containing only the "API Key" section, as per assignment.

The dark/light switch is also present, allowing the user to switch between the two themes on the top-right toggle.

The user can also press the Edit button in the right side of the info entries, opening a modal (not fully implemented).

About

💼 A successful take-home project I made for a job interview

https://nextjs-dashboard-yangxdev.vercel.app/

License:MIT License


Languages

Language:TypeScript 94.1%Language:CSS 4.9%Language:JavaScript 1.0%