-
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
117 additions
and
34 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,60 +1,143 @@ | ||
| # CountRie Overview | ||
| # CountRie | ||
|
|
||
| Can be accessed via [the link](https://countrie-fsohpe7vuq-lm.a.run.app/Country). | ||
| CountRie is a web application featuring a range of countries, characters, and their respective dependencies. Users can view and interact with data using a clean interface, create their own countries and characters, and engage in battles. | ||
|
|
||
| Web app featuring a range of countries, character, and their respective dependencies that the user can view and interact with using clean interface. | ||
| User can create an account to be able to create characters or countries. Characters or countries created by a user can be edited or deleted, but they cannot do that to the ones that are not theirs. | ||
| Admin account allows for full control over all data, having the ability to do even more than a regular user can. the admin email is used: [email protected]. | ||
| [Access CountRie](https://countrie-fsohpe7vuq-lm.a.run.app) | ||
|
|
||
| Battles can be created between characters, improving their power. A name can be provided for a battle, or innovative name generator might be used instead. | ||
| All battles of a specific character can be viewed on the respective page, as well as characters of a country, etc. | ||
| ## Table of Contents | ||
| - [Overview](#overview) | ||
| - [Features](#features) | ||
| - [Architecture](#architecture) | ||
| - [Technologies](#technologies) | ||
| - [Installation and Setup](#installation-and-setup) | ||
| - [CI / CD](#ci--cd) | ||
| - [Database Schema](#database-schema) | ||
| - [Screenshots](#screenshots) | ||
| - [Contributing](#contributing) | ||
| - [License](#license) | ||
| - [Contact](#contact) | ||
|
|
||
| Built using clean architecture and design patterns, providing for easy development process and possible future extensions or changes. | ||
| CI / CD workflow is in use for easy integration and deployment. | ||
| ## Overview | ||
|
|
||
| # Details | ||
| CountRie allows users to: | ||
| - Create an account and log in | ||
| - View and interact with countries and characters | ||
| - Create, edit, and delete their own countries and characters | ||
| - Engage in battles between characters, improving their power | ||
| - View battle history and character details | ||
|
|
||
| Admin accounts have full control over all data. The admin account has an email of [email protected]. | ||
|
|
||
| ## Features | ||
|
|
||
| - State of the art authentication system | ||
| - Role-based access to the resources | ||
| - State-of-the-art authentication system | ||
| - Role-based access to resources | ||
| - Ownership of countries/characters | ||
| - Supports CRUD operations for all models | ||
| - Only authorized users can edit or delete respective models | ||
| - Innovative battle system | ||
| - Robust validation system, providing for both intuitive user-experience, as well as protection from bad actors | ||
| - CRUD operations for all models | ||
| - Innovative battle system with name generator | ||
| - Robust validation system for user experience and security | ||
|
|
||
| ## Architecture | ||
|
|
||
| - Clean architecture with SQRS pattern | ||
| - Onion architecture used to make separations of concerns easier | ||
| - Dependency Inversion used for decoupling and easy extension | ||
| - Great respect to DRY, KISS, SOLID | ||
| - Clean architecture with CQRS pattern | ||
| - Onion architecture for separation of concerns | ||
| - Dependency Inversion for decoupling and easy extension | ||
| - Adherence to DRY, KISS, and SOLID principles | ||
|
|
||
| ## Technologies | ||
|
|
||
| ### Backend | ||
| - ASP.NET Core MVC | ||
| - Entity Framework Core | ||
| - Identity | ||
| - Docker | ||
| - Identity for authentication and authorization | ||
|
|
||
| ### Database | ||
| - PostgreSQL | ||
|
|
||
| ### Deployment | ||
| - Docker | ||
| - Aiven for database hosting | ||
| - Google Cloud Platform | ||
| - Google/Facebook login | ||
| - Bootstrap | ||
|
|
||
| ### Frontend | ||
| - Bootstrap for responsive design | ||
|
|
||
| ### Authentication | ||
| - Google/Facebook login integration | ||
|
|
||
| ## Installation and Setup | ||
| Dotnet 8 SDK and runtime is needed to run the app locally, which can be downloaded at: https://dotnet.microsoft.com/en-us/download/dotnet/8.0 | ||
|
|
||
| 1. Clone the repository: | ||
| ``` | ||
| git clone https://github.com/yourusername/CountRie.git | ||
| ``` | ||
| 2. Navigate to the project directory: | ||
| ``` | ||
| cd CountRie | ||
| ``` | ||
| 3. Install dependencies: | ||
| ``` | ||
| dotnet restore | ||
| ``` | ||
| 4. Set up your database connection string in `appsettings.json` | ||
| 5. Install dotnet tools: | ||
| ``` | ||
| dotnet tool install --global dotnet-ef | ||
| ``` | ||
| 6. Run database migrations: | ||
| ``` | ||
| dotnet ef database update --project ./Data --startup-project ./Web | ||
| ``` | ||
| 7. Start the application: | ||
| ``` | ||
| dotnet run | ||
| ``` | ||
|
|
||
| ## CI / CD | ||
|
|
||
| Features separate workflows for CI (Continuous Integration) and CD (Continous Deployment). | ||
| The project is automatically built into docker container, uploaded to cloud, and deployed to run. All automatically. The integration provides for seamless developing experience and ease of use. | ||
| The project uses separate workflows for Continuous Integration (CI) and Continuous Deployment (CD): | ||
|
|
||
| - CI: Automatically builds and tests the project on each push or pull request. | ||
| - CD: Automatically builds the project into a Docker container, uploads it to the cloud, and deploys it to run. | ||
|
|
||
| This setup provides a seamless development experience and ease of use. | ||
|
|
||
| ## Database Schema | ||
|
|
||
|  | ||
|
|
||
| ## Screenshots | ||
|
|
||
| 1. Home Page | ||
|  | ||
|
|
||
| 2. Country Creation | ||
|  | ||
|
|
||
| 3. Character Details | ||
|  | ||
|
|
||
| 4. Admin Editing | ||
|  | ||
|
|
||
| 5. Battle Dashboard | ||
|  | ||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome contributions to CountRie! Please follow these steps: | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a new branch for your feature | ||
| 3. Commit your changes | ||
| 4. Push to your branch | ||
| 5. Create a new Pull Request | ||
|
|
||
| # Database schema | ||
| ## License | ||
|
|
||
|  | ||
| This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. | ||
|
|
||
| # Screenshots | ||
| ## Contact | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
| For any questions or feedback, please open an issue on GitHub or contact the maintainer at [email protected]. |