An open API service indexing awesome lists of open source software.

https://github.com/andreagriffiths11/we-coded


https://github.com/andreagriffiths11/we-coded

copilot-enabled dev git github

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# WeCoded Game

A gamified interactive experience celebrating diversity in tech through storytelling and engagement with real tech journey stories from the DEV.to community.

![WeCoded Game Banner](public/wecoded.svg)

## ๐ŸŽฎ Features

- **Interactive Story Cards**: Browse through authentic tech journey stories from diverse backgrounds
- **Mini-Game**: Engage with an interactive element demonstrating diversity concepts
- **Progress Tracking**: Track your journey through different stories and contributions
- **Accessibility First**: Full support for various accessibility needs including high contrast mode and reduced motion
- **Real-time Updates**: Fresh content pulled from DEV.to's #wecoded tag

## ๐Ÿ› ๏ธ Tech Stack

- Next.js 15 with App Router
- TypeScript
- CSS Modules with CSS Variables
- Geist Font Family
- Jest & React Testing Library

## ๐Ÿš€ Getting Started

1. Clone the repository:
```bash
git clone https://github.com/yourusername/wecoded-game.git
cd wecoded-game
```

2. Install dependencies:
```bash
npm install
```

3. Run the development server:
```bash
npm run dev
```

Open [http://localhost:3000](http://localhost:3000) to see the game in action!

## ๐Ÿ“– Project Structure

```
app/ # Next.js app directory
โ”œโ”€โ”€ api/ # API routes
โ”œโ”€โ”€ globals.css # Global styles
components/ # React components
hooks/ # Custom React hooks
public/ # Static assets
types/ # TypeScript definitions
```

## ๐ŸŽจ Design System

- Follows atomic design principles
- Uses CSS variables for theming
- Supports light/dark modes
- Implements WCAG 2.1 AA standards

## โ™ฟ Accessibility Features

- High contrast mode
- Reduced motion preferences
- Large text options
- Screen reader optimized
- Keyboard navigation support

## ๐Ÿงช Testing

Run the test suite:
```bash
npm test
```

We use:
- Jest for unit testing
- React Testing Library for component testing
- Integration tests for game mechanics

## ๐Ÿ“ Development Guidelines

- Use TypeScript for all new components
- Follow atomic design principles
- Add JSDoc comments for functions and components
- Ensure accessibility compliance
- Test new features thoroughly

## ๐Ÿš€ Deployment

The game is automatically deployed to GitHub Pages on main branch updates. The deployment workflow is handled by GitHub Actions.

To build for production:
```bash
npm run build
```

## ๐Ÿค Contributing

1. Fork the repository
2. Create your feature branch
3. Follow our development guidelines
4. Ensure tests pass
5. Submit a pull request

## ๐Ÿ“„ License

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

---

Built with โค๏ธ for the WeCoded Challenge 2025