mrkrk/formaptix-web
1
0
Fork 0
mirror of https://github.com/grey-cat-1908/formaptix-web.git synced 2024-11-11 18:47:27 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

README

Browse source
This commit is contained in:
mrkrk 2024-08-30 20:00:04 +03:00 committed by GitHub
parent 26f3f7b186
commit 6685013f35
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 53 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

77
README.md
View file

@ -1,39 +1,68 @@
# formaptix-web # Formaptix Frontend
This template should help get you started developing with Vue 3 in Vite. This repository contains the source code for the Formaptix frontend, as well as a short tutorial on how to run it on the server yourself.
## Recommended IDE Setup ## Guide
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur). Simple guide
## Type Support for `.vue` Imports in TS ### Preparing
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. * You need to install git to clone the project. You can find a simple guide [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
* Set up and run the Formaptix Server. You can find a guide in the [Formaptix Server Repository](https://github.com/grey-cat-1908/formaptix-server/).
* Install Node.js®. You can do that [here](https://nodejs.org/en/download/package-manager).
## Customize configuration Clone Formaptix frontend using the following command:
See [Vite Configuration Reference](https://vitejs.dev/config/). ```sh
git clone https://github.com/grey-cat-1908/formaptix-web.git
```
## Project Setup ### Configuring
You can configure nearly everything by setting up the following Enviroment Variables:
| Variable | Description | Value |
|---|---|---|
| `VITE_APP_NAME` | You can specify an app name to be displayed in the header and other parts of the website. | `Formaptixx` (default) |
| `VITE_API_URL` | You MUST specify Formaptix server url | **required** |
To specify all the enviroment variables you can create `.env` file. You can find `.env` file example [here](https://github.com/grey-cat-1908/formaptix-web/blob/master/.env.example).
### Building
To build project, you should go to the Formaptix frontend directory and run the following commands:
```sh ```sh
yarn yarn
```
### Compile and Hot-Reload for Development
```sh
yarn dev
```
### Type-Check, Compile and Minify for Production
```sh
yarn build yarn build
``` ```
### Lint with [ESLint](https://eslint.org/) ### Hosting
```sh You can host a built Formaptix frontend almost anywhere. You just need to host the `build' folder.
yarn lint
``` I can recommend using something like NGINX or Apache. Or just deploy it using CloudFlare Pages (or some alternative).
- - -
### Note
1. Although the README file is written in English, the site itself currently supports only Russian. There are plans to create website localization in the future.
2. If you suddenly decide to use the project even though you are not from Russia, you will still have to accept the existence of support for local validators (SNILS and TIN).
3. If you are from Russia, CloudFlare Pages may not work properly (`*.pages.dev` may be blocked). You should use an alternative or wait for the release of GitVerse Pages. Or just use a custom domain.
- - -
## Help
If you have any questions or want to get involved in the project in any way, you can use all GitHub instruments (Issues and Pull Requests) or just email me at [email](mailto:mail@mrkrk.me).
## Acknowledgements
Thanks to my friend Vyacheslav ([flyare](https://github.com/flyare1337)) with frontend and layout design.
## License
Distributed under the terms of the MIT License.