V2 - Monorepo

This repository contains the source code for the second iteration of my portfolio website, built with Next.js, Tailwind CSS, and Sanity. The project is structured as a monorepo using Yarn Workspaces and is managed with Turborepo.

Table of Contents

• V2 - Monorepo
  • Table of Contents
  • Introduction
  • Project Structure
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
  • Contributing
  • License

Introduction

This project is the second version of my portfolio, designed to be open-source, easily customizable, and deployable. It features a Next.js frontend and a Sanity CMS backend for content management.

The project was inspired by Praha's Framer template, which served as a design reference.

Project Structure

This monorepo is organized using Yarn Workspaces and Turborepo. The workspaces are located in the apps and packages directories:

• apps/web: The Next.js 14 frontend application.
• apps/studio: The Sanity CMS studio for content management.
• packages/*: Shared packages and utilities, including @v2/sanity-schemas for type-safe Sanity content.

Getting Started

Prerequisites

• Node.js (v18 or later)
• Yarn (v1.22 or later)
• Sanity CLI (install globally)

Installation

1. Clone the repository:

   git clone https://github.com/Maiz27/v2.git
   cd v2

2. Install dependencies from the root directory:

   yarn install

3. Set up environment variables:

   • For the web app, copy .env.example to .env in apps/web and provide your Sanity project details.
   • For the Sanity studio, please refer to the detailed instructions in the studio README.

Usage

This project uses Turborepo to manage scripts. You can run the following commands from the root directory:

• To start all applications in development mode:

  yarn dev

• To build all applications for production:

  yarn build

• To lint all applications:

  yarn lint

You can also run scripts for individual applications:

• yarn dev:web: Starts the development server for the web app.
• yarn dev:studio: Starts the development server for the Sanity studio.
• yarn build:web: Builds the web app for production.
• yarn build:studio: Builds the Sanity studio for production.
• yarn lint:web: Lints the web app.
• yarn lint:studio: Lints the Sanity studio.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes.

License

This project is open-source and available under the MIT License.