Skip to content

datfoosteve/PortableReactResume

 
 

Repository files navigation

Portable React Resume

A simple and customizable portfolio/resume page built with Next.js, React, and Tailwind CSS.

Table of Contents

Features

  • Responsive design for desktop and mobile devices
  • Easy customization with a data file and configuration options
  • Clean and minimalistic design using Tailwind CSS
  • Smooth scroll and smooth transition effects using React Spring
  • SEO-friendly and optimized for performance using Next.js

Getting Started

To get started with the project, follow these steps:

  1. Clone the repository to your local machine:

Copy code

git clone https://github.com/datfoosteve/PortableReactResume.git

  1. Install the dependencies:

Copy code

npm install

  1. Start the development server:

Copy code

npm run dev

The development server will start and the app will be available at http://localhost:3000.

Customization

To customize the content and appearance of the app, you can edit the data file and configuration options in the data directory.

  • The data/data.json file contains the data for your portfolio/resume, including your name, occupation, contact information, skills, projects, and social media links. You can edit this file to update the content of your portfolio/resume.

  • The data/config.js file contains the configuration options for the app, including the layout, color scheme, and other options. You can edit this file to customize the appearance of the app.

Deployment

To deploy the app, you can use the npm run build and npm run export commands to build and export the app as a static site. The static site will be generated in the out directory, which you can then upload to a hosting provider or server of your choice.

Built With

  • Next.js - A framework for building server-rendered React apps
  • React - A JavaScript library for building user interfaces
  • Tailwind CSS - A utility-first CSS framework
  • React Spring - A spring-based animation library for React

Contributing

If you would like to contribute to the project, please feel free to fork the repository and submit a pull request.

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details.

I hope this README.md file is helpful for your project! Let me know if you have any questions or suggestions for improvement.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 92.4%
  • CSS 6.9%
  • TypeScript 0.7%