Added Bootstrap and Vue I18N; added header and footer components; added language switcher

README.md

@@ -1,6 +1,22 @@
-# glossary_admin_client
+# NATO  Glossary, Admin Client
 
-This template should help get you started developing with Vue 3 in Vite.
+This is the repo for the admin client of the NATO Glossary project. This README will explain all basic commands for running, developing, testing, and building the app.
+
+## Stack
+
+- [Vue 3](https://vuejs.org/) + [Vite](https://vite.dev/)
+- [TypeScript](https://www.typescriptlang.org/)
+- [Bootstrap](https://getbootstrap.com/) for UI and styling
+- [Vue I18N](https://vue-i18n.intlify.dev/) for multi-language options
+- [Pinia](https://pinia.vuejs.org/) for state management
+- [Vitest](https://vitest.dev/) for unit testing
+- [Playwright](https://playwright.dev/) for end-to-end (e2e) testing
+- [ESLint](https://eslint.org/) for code linting
+- [Prettier](https://prettier.io/) for code formatting
+
+## File Structure
+
+Given the small scope of this project, we're beginning with a [Flat Structure](https://alexop.dev/posts/how-to-structure-vue-projects/#1-flat-structure-perfect-for-small-projects) to organize the files.
 
 ## Recommended IDE Setup
 
@@ -17,30 +33,36 @@ This template should help get you started developing with Vue 3 in Vite.
 
 ## Type Support for `.vue` Imports in TS
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Vue (Official)](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
 
 ## Customize configuration
 
 See [Vite Configuration Reference](https://vite.dev/config/).
 
-## Project Setup
+## First-Time Setup
 
-```sh
+Install dependencies:
+
+```bash
 npm install
 ```
 
-### Compile and Hot-Reload for Development
+## Development Environment
 
-```sh
+To properly run on and test this application, you'll need the following pieces to be running:
+
+- Development Server (the web app)
+- Local Database (a dev database that provides dummy data to testing)
+- Development API (the API that serves the dummy data from the database to the web app)
+
+### Development Server
+
+Start the development server on `http://localhost:3000`:
+
+```bash
 npm run dev
 ```
 
-### Type-Check, Compile and Minify for Production
-
-```sh
-npm run build
-```
-
 ### Run Unit Tests with [Vitest](https://vitest.dev/)
 
 ```sh
@@ -71,3 +93,21 @@ npm run test:e2e -- --debug
 ```sh
 npm run lint
 ```
+
+## Production
+
+Build the application for production:
+
+```bash
+# npm
+npm run build
+```
+
+Locally preview production build:
+
+```bash
+# npm
+npm run preview
+```
+
+Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.