|
1 | 1 | <div align="center" >
|
2 |
| - <img src="./packages/app/public/static/logo.png" width="60" alt=""> |
| 2 | + <img src="./packages/app/public/static/logo.png" width="60" alt="code-racer-logo"> |
3 | 3 | <br/>
|
4 | 4 | <h1>Code Racer</h1>
|
5 | 5 | </div>
|
6 | 6 |
|
7 |
| -<br/> |
8 |
| - |
9 | 7 | <div align="center">
|
10 |
| -Welcome to Code Racer, a community project built with <a href="https://nextjs.org/">Next.js</a>, <a href="https://tailwindcss.com">Tailwind CSS</a> and <a href="https://www.typescriptlang.org">TypeScript</a>. |
11 |
| -Code Racer is a multiplayer coding game where developers can compete against each other to solve programming challenges in real-time. Sharpen your coding skills, challenge your peers, and have fun while racing against the clock! |
| 8 | + Welcome to Code Racer, a community project built with <a href="https://nextjs.org/">Next.js</a>, <a href="https://tailwindcss.com">Tailwind CSS</a>, and <a href="https://www.typescriptlang.org">TypeScript</a>. |
| 9 | + Code Racer is a multiplayer coding game where developers can compete against each other to solve programming challenges in real-time. Sharpen your coding skills, challenge your peers, and have fun while racing against the clock! |
12 | 10 | </div>
|
13 | 11 |
|
14 |
| -## Features |
| 12 | +<div align="center"> |
| 13 | + <!-- TO ADD more Badges use -> https://shields.io/ --> |
| 14 | + |
| 15 | + <img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/webdevcody/code-racer"> |
| 16 | + <img alt="Repo License" src="https://img.shields.io/github/license/webdevcody/code-racer"> |
| 17 | + <img alt="Website Status" src="https://img.shields.io/website?url=https%3A%2F%2Fcode-racer-eight.vercel.app"> |
| 18 | + |
| 19 | + </div> |
| 20 | + |
| 21 | + |
| 22 | +## Table of Contents |
| 23 | + |
| 24 | +- [:rocket: Features](#features) |
| 25 | +- [:hammer_and_wrench: Technologies Used](#technologies-used) |
| 26 | +- [:handshake: Contribution](#contribution) |
| 27 | +- [:lock: License](#license) |
| 28 | +- [🙏🏻 Acknowledgements](#acknowledgements) |
| 29 | +- [:envelope: Contact](#contact) |
| 30 | +- [:clapper: Related Youtube Videos & Progress](#related-youtube-videos-progress) |
| 31 | + |
| 32 | +<a id="features"></a> |
| 33 | + |
| 34 | +## Features :rocket: |
15 | 35 |
|
16 | 36 | - Code snippet games
|
17 | 37 | - [Multiplayer races](./packages/wss/README.md)
|
18 | 38 |
|
19 |
| -## Technologies Used |
| 39 | +<a id="technologies-used"></a> |
| 40 | + |
| 41 | +## Technologies Used :hammer_and_wrench: |
20 | 42 |
|
21 |
| -- [Next.js](https://nextjs.org) : A React framework for building server-side rendered and statically generated applications. |
22 |
| -- [NextAuth](https://next-auth.js.org) : For user authentication. |
23 |
| -- [Prisma](https://www.prisma.io) : Next-generation ORM, it provides a clean and type-safe API for submitting database queries |
24 |
| -- [Tailwind CSS](https://tailwindcss.com) : A utility-first CSS framework for rapid UI development. |
25 |
| -- [TypeScript](https://www.typescriptlang.org): A typed superset of JavaScript that provides enhanced tooling and developer productivity. |
| 43 | +- [Next.js](https://nextjs.org): A React framework for building server-side rendered and statically generated applications. |
| 44 | +- [NextAuth](https://next-auth.js.org):For user authentication. |
| 45 | +- [Prisma](https://www.prisma.io):Next-generation ORM, it provides a clean and type-safe API for submitting database queries. |
| 46 | +- [Tailwind CSS](https://tailwindcss.com):A utility-first CSS framework for rapid UI development. |
| 47 | +- [TypeScript](https://www.typescriptlang.org):A typed superset of JavaScript that provides enhanced tooling and developer productivity. |
26 | 48 |
|
27 |
| -## Contribution |
| 49 | +<a id="contribution"></a> |
28 | 50 |
|
29 |
| -We welcome contributions from the community! If you'd like to contribute to Code Racer, please follow refer to [CONTRIBUTING.md](./CONTRIBUTING.md), but we have these base guidelines: |
| 51 | +## Contribution :handshake: |
30 | 52 |
|
31 |
| -- Fork the repository. |
32 |
| -- Create a new branch for your feature or bug fix. |
33 |
| -- Make your changes and test thoroughly. |
34 |
| -- Commit your changes with clear commit messages. |
35 |
| -- Push your branch to your forked repository. |
36 |
| -- Submit a pull request detailing your changes. |
| 53 | +We welcome contributions from the community! If you'd like to contribute to Code Racer, please refer to [CONTRIBUTING.md](./CONTRIBUTING.md). We have these base guidelines: |
| 54 | + |
| 55 | +- Fork the repository |
| 56 | +- Create a new branch for your feature or bug fix |
| 57 | +- Make your changes and test thoroughly |
| 58 | +- Commit your changes with clear commit messages |
| 59 | +- Push your branch to your forked repository |
| 60 | +- Submit a pull request detailing your changes |
37 | 61 |
|
38 | 62 | Please ensure that your code adheres to the project's coding standards and conventions.
|
39 | 63 |
|
40 |
| -## License |
| 64 | +## License :lock: |
| 65 | + |
| 66 | +<a id="license"></a> |
41 | 67 |
|
42 | 68 | The Code Racer project is licensed under the MIT License. Feel free to use, modify, and distribute the code as per the terms of the license.
|
43 | 69 |
|
44 |
| -## Acknowledgements |
| 70 | +<a id="acknowledgements"></a> |
| 71 | + |
| 72 | +## Acknowledgements 🙏🏻 |
45 | 73 |
|
46 | 74 | Code Racer wouldn't be possible without the valuable contributions and support from the open-source community. We would like to express our gratitude to all the contributors and acknowledge the following libraries and resources used in this project.
|
47 | 75 |
|
48 | 76 | A big thank you to all the developers who have helped shape Code Racer into what it is today!
|
49 | 77 |
|
50 |
| -## Contact |
| 78 | +<a id="contact"></a> |
| 79 | + |
| 80 | +## Contact :envelope: |
51 | 81 |
|
52 |
| -If you have any questions, suggestions, or feedback regarding Code Racer, please feel free to reach out to us at in the WebDevCody [discord](https://discord.gg/4kGbBaa) server |
| 82 | +If you have any questions, suggestions, or feedback regarding Code Racer, please feel free to reach out to us at in the WebDevCody [discord](https://discord.gg/4kGbBaa) server. |
53 | 83 |
|
54 | 84 | Happy coding and enjoy the race!
|
55 | 85 |
|
56 |
| -## Related Youtube Videos & Progress |
| 86 | +<a id="related-youtube-videos-progress"></a> |
| 87 | + |
| 88 | +## Related Youtube Videos & Progress :clapper: |
57 | 89 |
|
58 | 90 | 1. [Community Project Announcement Video](https://www.youtube.com/watch?v=-n6tV3RPjGc)
|
59 | 91 | 2. [First Q&A Livestream and Community Project Live Coding Session](https://www.youtube.com/watch?v=BQXXBsHXfak)
|
| 92 | +3. [How to contribute to open source projects (our community project walkthrough)](https://www.youtube.com/watch?v=dLRA1lffWBw) |
| 93 | +4. [You need to write tests when this starts to happen](https://www.youtube.com/watch?v=PzrhclEQp-M) |
| 94 | +5. [CodeRacer had a major security issue](https://www.youtube.com/watch?v=FigpqBGqwK4) |
| 95 | +6. [Stop calling prisma inside server components](https://www.youtube.com/watch?v=sLIoCfKK5SA) |
60 | 96 |
|
61 | 97 | <details>
|
62 | 98 | <summary>
|
63 |
| - <h2>How To(s) - A newbie section</h2> |
| 99 | + <h2>How To(s) - A newbie section</h2> |
64 | 100 | </summary>
|
65 | 101 |
|
66 | 102 | ### Check the logs of Post
|
|
0 commit comments