tnmyk / Portfolio-Generator

A Portfolio Generator website developed using NextJS

Portfolio Generator

A Portfolio Generator website developed using NextJS
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

A Portfolio Generator website developed using NextJS

Built With

• NextJS
• styled-components
• ReactJS

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm i npm@latest -g
  # or
  npm i -g yarn

Installation

1. Clone the repo

   git clone https://github.com/DSCVITBHOPAL/Portfolio-Generator.git

2. Install NPM packages

   npm i
   # or
   yarn

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

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

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 to staging branch.

Creating an Issue

1. Try to give a thorough description of issue so that it can be easily understood
2. Try providing scshots or ways to reproduce the errors if possible

Working on an Issue

1. Try to get the issue assined to you before working to avoid multiple people working on same issue

Points System💻

We decided to come up with a point system for all of our repositories under GDSC, VIT Bhopal and here's how it looks.

Levels	Task	Points
Level 0	Documentation & Minor Fixes	5
Level 1	Minor Feature addition & Major Bug Fixes	10
Level 2	Major Feature or Component	15

This how the points will be awarded for your respective contributions. This will help us reward our contributors at the end of the year.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/DSCVITBHOPAL/Portfolio-Generator