Skip to content

Latest commit

 

History

History
115 lines (69 loc) · 5.16 KB

README.md

File metadata and controls

115 lines (69 loc) · 5.16 KB
Raw

PORTFOLIO

Portfolio Application

This personal portfolio project was built with React.js, Styled Components, TypeScript, and Sanity. It features a clean and modern design, showcasing my work and accomplishments in web development.

Application in Action

Visit the application live demo.

Screenshot 2023-02-06 at 10 23 39 AM

Built With

The website is built with popular web technologies, including React for building user interfaces, Styled Components for styling components with CSS, and TypeScript for improved code readability. It also utilizes Sanity for managing and delivering structured content:

  • React.js is a JavaScript library for building user interfaces. It allows developers to create reusable components that can be easily composed to build complex applications.
  • Styled Components is a library for styling React components with CSS. It allows developers to write CSS styles directly in their JavaScript code, making it easy to apply styles to individual components.
  • Sanity is a platform for building structured content and digital experiences. It provides a powerful set of tools for creating, managing, and delivering structured content, including a flexible data schema, a rich text editor, and an API for querying and retrieving content.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

  • git

    If you want to clone the project from GitHub and work with it locally, you will need to have Git installed on your system. You can download and install Git from the official website (https://git-scm.com/).

  • Node.js

    Application requires Node.js to be installed on your system in order to run. You can download and install the latest version of Node.js from the official website (https://nodejs.org/).

  • npm (Node Package Manager)

    npm is the package manager for Node.js, and is used to manage the dependencies and packages required for your Next.js project. It is installed automatically when you install Node.js.

    To check if npm is installed on your system, you can open a terminal or command prompt and enter the following command:

    npm -v

Once you have these prerequisites in place, you can proceed to clone the project from GitHub using Git.

Installing

Make sure you have all the necessary prerequisites installed on your system. Follow the below steps to install the setup the project on your machine:

  • Open a terminal or command prompt and navigate to the directory where you want to clone the project.

  • Run the following command to clone the project from GitHub:

    git clone https://github.com/t-creates/portfolio.git

  • This will create a new directory called "portfolio" in the current location, containing the code for the Portfolio project.

  • Navigate to the project directory by running the following command:

    cd portfolio

  • Run the following command to install the project's dependencies using npm:

    npm install

  • Once the dependencies are installed, you can run the project locally by running the following command:

    npm start

    This will start the development server and open the Portfolio application in your default web browser.

  • To run the sanity, navigate to the "cms" folder in your terminal

    cd cms

    Run the following command to install the required dependencies

    npm install

    Run the following command to start the Sanity Studio

    npm run start

    This will start the Sanity Studio, which is the web-based interface for managing and editing your project's content. The Studio will be available at http://localhost:3333 in your web browser.

Note: If you want to set up your Sanity content platform which is used to manage and deliver structured content for the portfolio website, you have to create your own project that will provide the project ID, dataset name, and token.

Contributing

We welcome contributions to Portfolio! If you have an idea for a new feature, an improvement to an existing feature, or a bug fix, please open an issue to discuss it before submitting a pull request. This helps me to review and understand your changes more efficiently.

To contribute code to Portfolio:

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Commit your changes to the new branch
  4. Run the automated tests to ensure that your changes do not break any existing functionality
  5. Open a pull request back to the main repository, including a description of your changes and any relevant issue numbers

Please ensure that your code follows the coding style and standards used in the rest of the project. Thank you for your contribution to Portfolio! We appreciate your efforts to help make this a great portfolio application.