Skip to content

ByteXync/Commit-And-Conquer

Repository files navigation

Commit And Conquer

Overview

The repository contains a full-stack application with a Next.js frontend and a FastAPI backend, with connection to a postgresql (use of neondb is recommended)...

Folder Structure

repo-root/
├── CLIENT/   # Next.js frontend application
├── SERVER/   # FastAPI backend

Prerequisites

  • Ensure you have Node.js installed for setting up nextjs.
  • Python 3 installed for setting up FASTAPI .

Setup Instructions

CLIENT (Frontend - Next.js)

  1. Navigate to the CLIENT folder:
    cd CLIENT
  2. Install dependencies:
    npm install
  3. Start the development server:
    npm run dev
  4. The frontend should now be running at http://localhost:3000

SERVER (Backend - FastAPI)

  1. Navigate to the SERVER folder:
    cd SERVER
  2. Create a virtual environment:
    python -m venv venv
  3. Activate the virtual environment:
    • Windows:
      venv\Scripts\activate
    • macOS/Linux:
      source venv/bin/activate
  4. Install dependencies:
    pip install -r requirements.txt
  5. Generate Prisma client:
    prisma generate
  6. Start the FastAPI server:
    uvicorn main:app --reload
  7. The backend should now be running at http://localhost:8000

Contributing Guidelines

  1. Fork the repository and clone it locally:

    git clone https://github.com/your-username/your-repo.git
    cd your-repo
  2. Make your changes in the main branch of your fork.

  3. Commit your changes with a structured message:

    • Format:
      Update <file-name>
      
      Fixes #<issue-number>  
      Team <team-id>
      
    • Example:
      Update main.dart
      
      Fixes #1  
      Team 12
      
  4. Push your changes to your forked repository:

    git push origin main
  5. Go to the original repository and create a pull request (PR) from your fork’s main branch.

  6. A maintainer will review and merge your PR.

DO NOT MERGE YOUR CODE TO THE MAIN BRANCH OF THE MAIN REPOSITORY


Notes

  • The frontend and backend should run concurrently for full functionality.
  • Modify environment variables as needed.
  • If a team finds a issue or bugs they need to create it with a tag called Player-issue

LeaderBoard 🏆

  1. SayGex: 45
  2. Talaash : 35
  3. Code 404: 32
  4. Clueless : 10
  5. DQueen: 5
  6. Gitcoders: 5
  7. Merge Masters: 0
  8. what is git?: 0
  9. 404 Not Found : 0
  10. Anveshika: 0
  11. Low Day: 0
  12. Tech Titans : 0
  13. Codestorm : 0
  14. Bototrons: 0
  15. Anveshika : 0
  16. Team : 0
  17. Gitify: 0
  18. Thund3rbird : 0
  19. Aquaman: 0
  20. Super queens: 0
  21. Quark Script: 0
  22. Team 201: 0
  23. Team Mast Orbiters: 0
  24. Team UNO: 0
  25. Yeagerists: 0
  26. Kisi ka laptop kisi ka code: 0
  27. Bottle cap: 0
  28. Code phatt gya: 0
  29. oggy & the cockroaches : 0
  30. Non Coders: 0
  31. Kshitij Prasad : 0
  32. Codepushers: 0
  33. Alpha four: 0
  34. OpnSrc: 0
  35. Abenders: 0
  36. code overflow: 0
  37. Dora team: 0
  38. Error : 0
  39. BitbyBit: 0
  40. DeVvoyagers: 0
  41. Merge Masters : 0
  42. Ctrl + c & Ctrl + v: 0
  43. Strive Squad : 0
  44. Game changers: 0
  45. RedEye: 0
  46. Aatu Jhaatu: 0
  47. Ace: 0
  48. Binary: 0
  49. Tech Titans: 0
  50. Cyber_Coders: 0
  51. Batch D2: 0
  52. Code-Cartel: 0
  53. Hackity: 0
  54. AS: 0
  55. Ujwal Kumar B R : 0
  56. SYNTAX ERROR: 0
  57. Hack: 0
  58. TEAM NDC: 0
  59. Vinith Chavan : 0
  60. Sujeet: 0
  61. BugSync: 0
  62. Byte Jinx: 0
  63. Caffeine Overdose : 0
  64. Dev cardio: 0
  65. Tech Titans : 0
  66. It'sworkingsomehow : 0
  67. Hacktivate: 0
  68. PR RANGERS: 0
  69. Leviathan Squad: 0
  70. Octagram: 0
  71. CypherSquad: 0

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 14