Skip to content

Latest commit

 

History

History
145 lines (120 loc) · 6.06 KB

File metadata and controls

145 lines (120 loc) · 6.06 KB
aRPG Timeline logo

aRPG Timeline

aRPG Timeline Discord Support on Patreon Figma

🧑‍💻 Become a Code Contributor

Want to help shape the future of arpg‑timeline?
Whether you're a skilled developer or just starting out, your code contributions are welcome - and appreciated.

This project exists to serve the aRPG community, and it gets better every time someone like you helps improve it.

Why Contribute?

  • 🎮 Support the aRPG community by keeping widgets accurate and up-to-date
  • 🧠 Learn and grow by contributing to a real-world project using Next.js, React, TypeScript, Tailwind, and modern tooling
  • 🚀 Make an impact - even small fixes or improvements help thousands of users
  • 🤝 Collaborate with others who share your interest in action RPGs

How to Get Involved

  1. Fork the repository and create a feature branch.
  2. Set up the project locally - check the README for setup instructions or join Discord for help.
  3. Make your changes following existing patterns and clean code practices.
  4. Open a pull request with a clear summary of what you've added or improved.

What Can You Work On?

  • Fix bugs or improve performance
  • Refactor UI components or enhance mobile support
  • Improve date handling or add timezone features
  • Suggest and implement new features
  • Pick up something from the growing backlog! Most of the issues are drafts in refinement, so do not hesistate to ask on Discord!

Features

  • Support for multiple games in a single dashboard
  • Display timestamps for current and upcoming season start and end dates
  • Live countdowns for upcoming seasons
  • Countdown timers for upcoming developer announcement streams
  • Twitch button that activates when a game or stream goes live
  • Customizable filters to adjust the dashboard to your preferences
  • Visual progress indicators showing how far along the current season is
  • Ability to add events directly to your preferred calendar apps
  • Content management powered by Sanity CMS for easy updates of games and seasons
  • Automated crawler for game notifications

Stack

Next.js
Next.js
TypeScript
TypeScript
React
React
Tailwind CSS
Tailwind CSS
Vercel
Vercel
Sanity
Sanity

Development

Prerequisites

  • Node >= 22
  • npm
  • contact maintainers for Sanity credentials or mock the response

Setup your environment

  1. Navigate to the arpg-timeline project directory.
  2. Create a .env file in the root of the project with the following variables:
DISCORD_URL=...
GITHUB_URL=...
GITHUB_REPO=...
BUY_ME_A_COFFEE_URL=...
SITE_URL=...
GOOGLE_SITE_VERIFICATION=...
CONTACT_EMAIL=...
NEXT_PUBLIC_SANITY_PROJECT_ID=...
NEXT_PUBLIC_SANITY_DATASET=...
SANITY_STUDIO_READ_TOKEN=...
SANITY_HOOK_SECRET=...
  1. Run npm i
  2. Run npm run dev
  3. Go to http://localhost:3000

Contributing

Thank you for considering contributing to the project! I appreciate your time, effort and will to help me build this website!
Please check out the Contributing guide for guidelines about how to proceed.

If you'd like to help maintaining the list with up-to-date information about new seasons without coding, visit this spreadsheet and request editor's access. Let me know on Discord that you'd like to help.

Tracking

Simple Analytics