Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 3.23 KB

README.md

File metadata and controls

80 lines (52 loc) · 3.23 KB
Raw

Getting Started with Tech Portfolio Template

This is a project aimed to help people have a tech portfolio and learn some good patterns to follow. It'a React JS based template.

Resources

Figma

Requirements

This template is being planned to be so simple to change content that you won't even need to know a lot of things. It's just a simple template that you can use to start your portfolio.

But if you wanna customise things here and there inside the template, you can do it. But the requirements for that are as follows:

  • React JS
  • React Router
  • SaSS
  • Tailwind CSS

Getting Started

Tech Portfolio Template is a client side only project and is built by modifying the Create React App scripts.

Installation and running

Step 1. Install modules

From a terminal, navigate to the project folder and run:

npm install

Step 2. Running in development mode

In the project folder run:

npm run start

This will start the React app in development mode Open http://localhost:3000 to view it in the browser.

Step 3. Build for testing and production use

A build of the app is necessary to deploy for testing purposes or for production use. To build the project run:

npm run build

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

One can contribute by creating pull requests, or by opening issues for discovered bugs or desired features.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Features List

  • Firstly, this is a simple template that you can use to start your portfolio.
  • Totally client side implementation. So easily host either on netlify or github pages.
  • Single data source with a proper structure to help you make it easy to customise and make it your own.
  • Well structured. So you can easily understand what's going on.
  • A separate skills page where there is a option to see how many skills you have, that matches with the required skills if someone wants to hire you.
  • Similarly a separate project page where a person can check how suitable are you for a project by matching the skills and functionalities you implemented in them. Or maybe just check them and see them in action if they are live. The project section is very well segregated.
  • It also offers content page. Nowdays, people are doing so much more than just development. If you write blogs, do podcasts, or have a youtube channel, you can add it to the content page which all have unique sections of their own.
  • An easy configuration object if you don't want to show a particular page, or disable dark theme (😅 Idk why) but yeah it's there. - Testimonials Section have video testimonials option too. They give more authenticity. Don't they?

Helpful Resouce Links