Updated readme

This commit is contained in:
2026-02-06 13:39:14 +01:00
parent d79fe109c1
commit e9c5944654
2 changed files with 85 additions and 30 deletions
+85 -30
View File
@@ -1,36 +1,91 @@
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). <h1 align="center">
<br>
<a href="https://dev-run.netlify.app/">
<img src="public/dev-run-icon.svg" alt="DevRun" width="270">
</a>
<br>
DevRun
<br>
</h1>
## Getting Started <h4 align="center">
A community-driven competitive programming platform inspired by speedrunning.
<br>
Start a run, reset, improve your PB, and compete for the fastest times.
</h4>
First, run the development server: <p align="center">
<a href="#key-features">Key Features</a> •
<a href="#contributing">Contributing</a> •
<a href="#license">License</a>
</p>
![screenshot (TODO)](public/screenshot.png)
## Key Features
### Runs & Speedrunning Mechanics
- **Run-Based Gameplay** — Problems are played as _runs_, not isolated challenges. Start a run, solve problems in sequence, and race the clock.
- **Splits & PBs** — Track per-problem splits and your personal bests, just like speedrunning.
- **Reset & Retry** — Reset runs at any time and try again to beat your previous time.
### Problems & Categories
- **Curated Problem Sets** — Problems are grouped into runs with varying difficulty and themes.
- **Categories** — Compete in different categories such as Any%, No-Hints, or Practice.
- **No Interview Pressure** — DevRun is built for fun, learning, and improvement, not job prep.
### Leaderboards & Community
- **Global & Weekly Leaderboards** — Compare runs with other DevRunners around the world.
- **Runner Profiles** — View stats like total runs, PBs, and recent attempts.
- **Community-First Design** — Competitive, but casual. Built for hobbyists.
### UI & Experience
- **Minimal, Dark UI** — Black theme with subtle purple highlights, designed for focus.
- **Fast & Responsive** — Lightweight interface with subtle motion and feedback.
- **Speedrunning Language** — Runs, PBs, resets, clean runs, the culture comes first.
### Planned Features
- Custom runs and community-created problem sets
- Seasonal events and themed runs
- More categories and run modifiers
## Contributing
DevRun is a community-driven project, and contributions of all kinds are welcome — code, design, ideas, and feedback.
### Ways to Contribute
- **UI / UX improvements** — layout tweaks, animations, accessibility, theming
- **Problem & run ideas** — suggest fun challenges or speedrun-style categories
- **Bug reports** — even visual or copy issues help a lot
- **Docs & copy** — improve wording, onboarding, or community tone
### Guidelines
- Keep things **simple and playful** — DevRun is not an interview platform.
- Prioritize **clarity, performance, and readability** over cleverness.
- Avoid over-engineering; this project values iteration and experimentation.
- Be respectful and constructive — competition stays in the runs, not the PRs.
### Getting Started
1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Open a pull request with a clear description of what you changed and why
---
By contributing, you agree to follow the project’s Code of Conduct.
```bash ```bash
git clone https://github.com/orus-dev/devrun.git
cd devrun
npm install
npm run dev npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
``` ```
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
## Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
## Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
Binary file not shown.

After

Width:  |  Height:  |  Size: 334 KiB