Interview Ready Docs

This repository contains the documentation for the Interview Ready project, designed to help developers prepare for technical interviews.

Contents

• Installation
• Usage
• Contributions
• Project Structure
• License

Installation

To install and run the project locally, follow these steps:

1. Clone the repository:

   git clone https://github.com/conanbatt/interview-ready-docs.git

2. Navigate to the project directory:

   cd interview-ready-docs

3. Install the dependencies:

   npm install

4. Start the development server:

   npm run dev

Usage

Once the development server is running, you can access the documentation in your browser at http://localhost:3000.

Contributions

Contributions are welcome. If you want to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/new-feature).
3. Make your changes and commit them (git commit -m 'Add new feature').
4. Push your changes to your fork (git push origin feature/new-feature).
5. Open a Pull Request.

Project Structure

• pages/: Contains the documentation pages.
• components/: Reusable components used in the documentation.
• theme.config.tsx: Theme configuration for the documentation.
• package.json: npm configuration file.

License

This project is licensed under the MIT License. For more details, see the LICENSE file.