-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
61 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,65 @@ | ||
| # Game Player Nick Finder [](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#work-in-progress) | ||
|
|
||
| Demo: https://gpnf.zentala.io/ | ||
| ## 🌏 Project Overview | ||
| Welcome to the "Game Player Nick Finder" - a unique platform to reconnect with your old online gaming friends deployed at [gpnf.zentala.io](https://gpnf.zentala.io/). | ||
|
|
||
| ## Overview | ||
| Game Player Nick Finder is a web application written in Django, allowing users to search for their old online gaming friends based on their nicknames. Users can also register on the platform to be found by other players. Additionally, users can add their gaming characters from various games, define descriptions, and specify the date range when they played under a particular nickname. The application also features a messaging system and email notifications. | ||
| ### 🎮 Key Features | ||
| - **Search by Nicknames**: Easily find your old gaming friends using their nicknames. | ||
| - **User Registration**: Join the community and let others find you. | ||
| - **Character Profiles**: Create detailed profiles for your gaming characters with descriptions and timelines. | ||
| - **Messaging System**: Communicate directly with your old friends on the platform. | ||
| - **Email Notifications**: Stay updated on new friend requests and messages. | ||
|
|
||
| ## 🛠 Technical Stack Overview | ||
|
|
||
| | Category | Technology | | ||
| | :---------- | :------------------------------------------------------------------------------------------- | | ||
| | Front-end |   | | ||
| | Back-end |   | | ||
| | Environment |  | | ||
| | DevOps |  | | ||
| | DBs |  | | ||
| | Marketing |  | | ||
| | IDE |  | | ||
|
|
||
| ## 🏗 Current & Planned App Architecture | ||
| ### Current Backend: [Django Full-Stack App in `server` Directory](https://github.com/zentala/game_player_nick_finder/tree/master/server) | ||
| - Our current setup uses Django for server-side rendering, efficiently delivering static content and managing server-client interactions. | ||
| - Django's ORM is integral for database interactions, while Django Views handle business logic and data presentation. | ||
|
|
||
| #### Planned Transition to API-Driven Architecture | ||
| - The next phase involves shifting to Django REST Framework for API endpoints creation, setting the stage for a more dynamic, interactive frontend. | ||
| - These API endpoints will be consumed by a [Planned React.js Client](https://github.com/zentala/game_player_nick_finder/tree/master/client) for enhanced user experiences. | ||
|
|
||
| ### Planed initial [Future React.js Client in `client` directory](https://github.com/zentala/game_player_nick_finder/tree/master/client) | ||
| - Contains the foundational setup for the future React.js application, awaiting development post-API integration. | ||
|
|
||
| ### Current Development Focus | ||
| 1) The immediate goal is to achieve MVP functionality, including character creation flows, friend search optimization, and user account panels for game and character management. | ||
| 2) Current priorities include contact information sharing, friend request features, and notification systems for new user additions. | ||
| 3) Long-term plans include implementing a user-to-user chat system. | ||
| 4) The React.js development is deferred for now, focusing instead on completing the business logic and core functionalities. | ||
|
|
||
| ## Code quality status | ||
|
|
||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
| [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) [](https://sonarcloud.io/summary/new_code?id=game_player_nick_finder) | ||
|
|
||
| ## 🤝 Join the Community! | ||
|
|
||
| ### 👾 ...of Old Forgotten Gaming Friends | ||
|
|
||
| Join the "Game Player Nick Finder" platform by registering at [gpnf.zentala.io](https://gpnf.zentala.io/accounts/register/). Fill out your gaming history, the more players join, the greater the chances of reconnecting with old gaming friends. Let's build a thriving community together! | ||
|
|
||
| ### 🖥️ ...of App Developers Community | ||
|
|
||
| Contribute to the "Game Player Nick Finder" project by: | ||
| * Starring & Watching this repo to stay updated with the latest features and releases. | ||
| * Picking tasks in our [GitHub Project](https://github.com/zentala/game_player_nick_finder/projects). | ||
| * Sharing your suggestions and reporting bugs in the [Issues](https://github.com/zentala/game_player_nick_finder/issues) section. | ||
|
|
||
| Your input helps us evolve and improve the platform for the benefit of all gamers. |