/open-profile

Unified profile to showcase your work.

Primary LanguageTypeScriptMIT LicenseMIT

Open Profile

Unified profile to showcase your work.

How it works

The app will fetch your data from different sources and display them in a single page.

Currently we fetch data from:

  • GitHub
  • Data from a JSON file created by the user

Installation

git clone https://github.com/thtauhid/open-profile
cd open-profile
npm install

To run the development server:

npm run dev
npm run build

Development

Currently, we are following this wireframe for the UI.

Deployment

You can deploy this project to any static site hosting service.

Some of the popular ones are:

Contributing

Contributing Guide

Feel free to open an issue if you find a bug or want to suggest a feature.

hacktoberfest

  1. Star the repo if you like it. ⭐
  2. Please read the rules before opening a pull request.
  3. Join our Discord server to discuss ideas, ask questions, collaborate and connect with like-minded people.
  4. The maintainer(s) will add the hacktoberfest-accepted label after reviewing and accepting your pull request.
  5. Refer to the dedicated hacktoberfest project view to see what issues are available to work on.
  6. You can also create your own issue if you have something in mind.
  7. Low quality PRs will not be merged

Tech Stack

  • Front-End: React(with TypeScript), Vite (Build Tool), Tailwind CSS, shadcn ui
  • Linting and Code Quality: ESLint, @typescript-eslint (TypeScript-specific linting)
  • Routing: React Router (Client-side routing)
  • Build and Package Management: npm (Node Package Manager)

Contributors

Made with contrib.rocks.

License

MIT License