Skip to content

Vikesh8107/QuillAudits

Repository files navigation

QuillAudits Frontend Assignment

Introduction

This is the frontend assignment project for Quillhash. The task was to create a webpage as similar as possible to the provided Figma design using Next.js, Tailwind CSS, TypeScript, and React.

Installation

To run this project locally, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/Vikesh8107/QuillAudits.git
  2. Navigate into the project directory:

    cd QuillAudits
  3. Install dependencies using npm or yarn:

    npm install
    # or
    yarn install

Running the Project

To start the development server, use the following command:

npm run dev
# or
yarn dev

This will start the Next.js development server at http://localhost:3000.

Project Structure

  • pages/: Contains all the Next.js pages for the application.
  • components/: Contains reusable React components.
  • public/: Contains static assets like images.
  • README.md: This file with project information.

Contributing

If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch with a descriptive name: git checkout -b feature/new-feature.
  3. Make your changes and commit them: git commit -am 'Add new feature'.
  4. Push to the branch: git push origin feature/new-feature.
  5. Submit a pull request with detailed information about your changes.

Additional Information

  • Make sure you have Node.js and npm (or yarn) installed on your machine.
  • The project is set up with Tailwind CSS for styling.
  • TypeScript is used for type-checking and improving code quality.

Feel free to explore the code and make any necessary modifications.

For support - [email protected]

About

This is the assignment given by the QuillAudits.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published