added readme

README.md

@@ -1,3 +1,64 @@
 # ShareLink
 ## Introduction
-### ShareLink is a website designed to assist developers in quickly sharing and accessing links to various best practices. It enables users to filter or search for links by tags, covering all layers of development: databases, backend, frontend, cloud, CI/CD. The primary goal of ShareLink is to showcase comprehensive code writing skills for portfolio purposes.
+ShareLink is a website designed to assist developers in quickly sharing and accessing links to various best practices. It enables users to filter or search for links by tags, covering all layers of development: databases, backend, frontend, cloud, CI/CD. The primary goal of ShareLink is to showcase comprehensive code writing skills for portfolio purposes.
+
+## Technologies
+  * Azure
+  * Docker
+  * GitHub Actions (for CI/CD)
+  * ASP.NET 8
+  * PostgreSQL
+  * React
+  * TypeScript
+  * Tailwind CSS
+
+## Features
+    * User authentication
+    * Social sign in: Google, GitHub.
+    * CRUD operations for links
+    * Filtering and searching for links
+    * Pagination
+    * Tagging links
+    * Sorting links by date, title, and rating
+    * Dark mode
+    * Responsive design
+
+## Screenshots or Demos
+Main page with all filters and link list.
+![Screenshot 1](/screenshot-mainpage.png)
+
+Adding link interface.
+![Screenshot 2](/screenshot-addlink.png)
+
+Sign in modal.
+![Screenshot 1](/screenshot-signin-modal.png)
+
+## Getting Started
+### Prerequisites
+  * Docker
+  * Docker Compose
+  * .NET 8.0
+  * Node.js
+  * npm
+
+Go to /server/readme.md and follow the instructions to run the server. Then go to /client/readme.md and follow the instructions to run the client.
+
+
+## License
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Contact
+  * [LinkedIn](https://www.linkedin.com/in/oleksandr-holub-ua/)
+  * [GitHub](https://github.com/saj113)
+  * [Email](mailto:a.golub113@gmail.com)
+  * [Portfolio](https://www.oleksandrholub.com/)
+
+## Acknowledgements
+    * [React](https://reactjs.org/)
+    * [TypeScript](https://www.typescriptlang.org/)
+    * [Tailwind CSS](https://tailwindcss.com/)
+    * [ASP.NET](https://dotnet.microsoft.com/apps/aspnet)
+    * [PostgreSQL](https://www.postgresql.org/)
+    * [Docker](https://www.docker.com/)
+    * [Docker Compose](https://docs.docker.com/compose/)
+    * [GitHub Actions](

client/README.md

@@ -1,27 +1,3 @@
-# React + TypeScript + Vite
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
-
-- Configure the top-level `parserOptions` property like this:
-
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
-```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+`npm run dev` - runs the app in the development mode.\
+`npm run build` - builds the app for production to the `build` folder.\