Skip to content

Latest commit

 

History

History
74 lines (48 loc) · 2.43 KB

README.md

File metadata and controls

74 lines (48 loc) · 2.43 KB

Laureate

A web app that helps you to transform your tweets into beautiful images with different gradient and color combinations.

Pull requests

Please ask first before starting work on any significant new features.

It's never a fun experience to have your pull request declined after investing a lot of time and effort into a new feature. To avoid this from happening, we request that contributors create a feature request to first discuss any significant new ideas.

Image of the application (Demo)

image

Table of Contents

Demo

Provide links to the deployed application for users to be able to view it easily. If you have any other links you would like to show here, feel free.

View the application at Deployed Project Link

Tech Stack

This is where you want to demonstrate the technologies you used in this project and provide any links.

Technology Description Link ↘️
NextJs The React Framework https://nextjs.org/
Tailwind CSS Utility-first CSS framework https://tailwindcss.com/
Zustand Bear necessities for state management https://github.com/pmndrs/zustand
Twitter api For fetching tweet data https://developer.twitter.com/en/docs/twitter-api

Installation

  1. Fork the project. Click on the fork icon in the top right to get started

  2. Clone the project, you can use the following command:

    git clone https://github.com/<your-github-username>/laureate
  3. Navigate to the project directory

    cd laureate
  4. Install dependencies with yarn install in both client and server folder

    yarn install
  5. Run yarn start

    yarn start

Contributing

  • Contributions make the open source community such an amazing place to learn, inspire, and create.
  • Any contributions you make are greatly appreciated.
  • Check out our contribution guidelines for more information.

License

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