diff --git a/README.md b/README.md index e63ff80..aedbac7 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,75 @@

- + +

Anagram Solver

-[![Deploy](https://github.com/ChainsOfPower/anagram-solver/actions/workflows/deploy.yml/badge.svg)](https://github.com/ChainsOfPower/anagram-solver/actions/workflows/deploy.yml) - license - last-commit - repo-top-language - repo-language-count + license + last-commit + repo-top-language + repo-language-count

+


-
+## Quick Links -# anagram-solver +> - [ Overview](#overview) +> - [ Features](#features) +> - [ Project Structure](#project-structure) +> - [ Getting Started](#getting-started) -This app allows admin user to schedule celebrities import from WikiData and unauthenticated users to resolve anagrams. +--- -## backend app -Backend is built using ASP.NET core and Postgres. +## Overview -## client app -Client is built using React and TS and is deployed with backend as a single unit. +The goal of this project is to be able to solve any anagram of famous person. We attend a pub quiz once a week and one of the questions is to solve anagram. That got us wonder what would take to create a web that does just that, and to be able to solve anagram of any famous person. We decided to tackle that challenge and to create this project as a fun side-project. -## deployment -App is dockerized and deployed to fly.io +--- +## Features +There are three main modules of this app, namely +- As admin, request import of famous people from wikidata, by just providing occupation id +- As admin, import person manually +- As anonymous user, enter anagram in input field and immediatelly get solution -## running app locally +--- +## Project Structure +Project is structured as ASP.NET monolith. + +In development, backend automatically starts react app and configures the proxy so that react app consumes mvc controllers. + +In production build, react app is built and bundled as APS.NET static asset, being served from it's index page. + +--- + +## Getting Started + +***Requirements*** + +Ensure you have the following dependencies installed on your system: + +* **dotnet**: `version 7.0 or higher` +* **dotnet SDK**: `version 7.0 or higher` +* **Node.js** `version 14.0.0 or higher` + +### Running locally + +1. Clone the Anagram Solver repository: + +```sh +git clone git@github.com:tvorova-tvornica/anagram-solver.git +``` + +2. Change to the project directory: + +```sh +cd anagram-solver +``` + +3. Run the app in watch mode: + +```sh dotnet watch +``` +---