A social media app designed for Tulane students to easily organize and join poker games on campus, compete and have fun!

FOLLOW OUR JOURNEY 🧑‍💻

Code Contributions

Bug Report

Please report any bug by opening an issue in the repo. Merci!

Feature Suggestion

Please recommend any new features by describing your idea in this form. Gracias!

Programming

1. Fork the repository: Click the "Fork" button at the top right corner of the repository page.
2. Clone your fork:

   gh repo clone tpthanh2006/PokerU

3. Create a new branch:

   git checkout -b feature-or-bugfix-name

4. Make your changes: Implement your feature or bug fix.

   cd .../software/frontend #to customize react-native frontend
   cd .../software/backend #to customize django backend

5. Commit your changes:

   git add .
   git commit -m "Describe what you've changed"

6. Push to your fork:

   git push origin feature-or-bugfix-name

7. Create a pull request: Go to the original repository and click the "New pull request" button. Provide a detailed description of your changes.

Code Conventions

Please follow these guidelines to maintain a consistent code style:

• Use 1 tab for indentation.
• Use descriptive and concise names for variables and functions.
• Adhere to these naming conventions:
  • Frontend:
    • Components: PascalCase
    • Global constants & enums: CONSTANT_CASE
  • Backend:
    • App: lowercase & underscores (e.g: blog_app)
    • Model: singular nouns, capitalized first letter (e.g: Person)
    • Field: lowercase & underscores (e.g: created_at)
    • URL: lowercase & hyphen-separated (e.g., /blog-posts/)
• Add comments to explain complex logic.

Installation Guide

This guide is used for developers. An installation guide for users will be created once the beta version is launched.

1. Install mobile emulator:

• Android
• iOS

2. Activate the terminal: Open Bash, CMD, or PowerShell
3. Install required packages: Navigate to frontend and backend to install packages for React Native and Django

   cd .../software/frontend
   npm i #install all packages for npm
   
   cd .../software/backend
   pip install -r requirements.txt

4. Run backend for server site:

   cd .../software
   python manage.py makemigrations
   python manage.py migrate
   python manage.py runserver
   #click on local host link

5. Run frontend for app site:

   cd .../software/frontend
   npm expo start
   #click on local host link

Development Options

• Open in Android Emulator: Press 'a'
• Open in iOS Simulator: Press 'i'
• Open in Expo Go: Scan QR code with the Expo Go app
• Open in web browser: Press 'w'

Authentication

The app uses Clerk for authentication. Make sure to set up your Clerk environment variables in:

Known Issues

• OperationalError, no such column. Django
  1. Delete the db.sqlite3 file
  2. Migrate changes: New db.sqlite3 will generates automatically

  python manage.py migrate

  3. Make migrations:

  python manage.py makemigrations

  4. Create the super user:

  python manage.py createsuperuser

• Migrations are not up to date with new models

API Documentation

The backend API endpoints are available at:

• Games: http://localhost:8000/api/games/
• Notifications: http://localhost:8000/api/notifications/
• Users: http://localhost:8000/api/users/
• Chat: http://localhost:8000/api/chat/
• Friends: http://localhost:8000/api/friends/

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Tech Stack

• Frontend: React Native (Expo)
• Backend: Django REST Framework
• Authentication: Clerk
• Database: SQLite (development) / PostgreSQL (production)

ER Diagram

This diagram represents the data entities (users, games, host, players, friends) and their relationships within the campus poker app

License

This project is licensed under the LICENSE.

Contact

If you need further assistance or have some questions, reach out to us on LinkedIn or sophienguyen113@gmail.com.

Thank you for making PokerU come true!