Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.39 KB
Raw

Welcome to GitHub Readme Daily Quotes contributing guide

Thank you for investing your time in contributing to our project!

Read our Code of Conduct to keep our community approachable and respectable.

We love your input and join us as a maintainer.

Here are the ways you can contribute to the project:

If you want to work on the project, please follow the local development guide.


Local Development

As we need Vercel for development, kindly create an account if you do not have one.

  1. Fork the repository and clone the code to your local machine.
  2. Run npm install in the repository root.
  3. Run the command vercel dev to start a development server at https://localhost:3000.
  4. The cards will then be available from this local endpoint (i.e. https://localhost:3000/api).

Optional - To work with API Ninjas

  1. Create a .env file in the root of the directory.
  2. In the .env file add a new variable named API_NINJAS_KEY with your API Ninjas Key (create an account if you do not have one).

Themes Contribution

GitHub Readme Daily Quotes supports custom theming. However, if you love a theme that is missing, or you want to contribute new themes, please kindly add the theme! 😊

All you need to do is edit the themes/index.ts file and add your theme at the end of the file.

While creating the Pull Request to add a new theme, don't forget to add the svg of the card.


License

By contributing, you agree that your contributions will be licensed under its MIT License.



Thank you! ❤️