Giter VIP home page Giter VIP logo

open-source-wrapped's Introduction

Open Source Wrapped with ❤️ by Schrodinger's Hat

Contributors Forks Stargazers Issues

Open Source Saturday Badge

Table of Contents
  1. About The Project
  2. Usage
  3. Contributing
  4. Contact

About The Project

This is the repository of the application Open Source Wrapped, a Spotify Wrapped Cameo to Open Source development

Tech stack

Usage

  • Create an OAuth App on GitHub in order to enable login with GitHub
  • Create .env.local file with all the necessary infos, see .env.example
  • Install the dependencies with npm ci or yarn
  • Run the development server with npm run dev or yarn dev

Open http://localhost:3000 with your browser to see the result. You can change the port with --portflag.

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Contact

Schrodinger's Hat Team - @schrodinger_hat

open-source-wrapped's People

Contributors

404answernotfound avatar abe-101 avatar lucasc87 avatar nicpuppa avatar thejoin95 avatar wabri avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

ehsanghaffar

open-source-wrapped's Issues

Update readme

The current readme is not correct. Need also to add a guide on how to create OAuth App on github and how to configure .env.local file

Improve the most used language part

Proposal

  • Instead of naming one top language here, list the 3 most used languages.
  • Refactor the wording from "best" language to "top" language or "most used" languages.

Select the year

By default is ok to go with the current year, but if I want to be curious and have the wrapped for previous years?

Create a landing page for the project where to fill the data to generate the image

We need to create a landing page that may render a few project information.

Through the landing page, you can also generate your wrapped image.

We must decide which solution is better.

  • use a Login with GitHub button (as already present in main) and use it to retrieve the user who wants to generate the image
  • use a form where the user may be able to insert its GitHub handle to receive its image

Add new utils function to draw

Let's start by creating utils functions to be imported in the code:

  • draw circle
  • draw square/rectancle
  • draw star
  • draw other

Create a developer app on Github

We need it in order to retrieve the data.

We can check if we can retrieve the data by curl the github.com website, but I'm not sure if the policy allow us to do it

Scaffold Nextjs13 app

  • Star obtained during the year
  • Number of projects you had contributed
  • Number of commits or line of codes

Add Open Source Saturday Badge in README

Open Source Saturday

We work on this project during the OSS Milano last Saturday, the only rule is to add the badge to every PR submitted during the event. But since we do not have a pr I think it's nice to add the badge to the project!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.