Updated README
This commit is contained in:
parent
d0af42e40b
commit
7546ad66e3
11
README.md
11
README.md
|
@ -3,12 +3,14 @@
|
||||||
## Technologies
|
## Technologies
|
||||||
|
|
||||||
#### [Back](https://github.com/Accords-Library/strapi.accords-library.com)
|
#### [Back](https://github.com/Accords-Library/strapi.accords-library.com)
|
||||||
|
|
||||||
- CMS: Stapi
|
- CMS: Stapi
|
||||||
- GraphQL endpoint
|
- GraphQL endpoint
|
||||||
- Multilanguage support
|
- Multilanguage support
|
||||||
- Markdown format for the rich text fields
|
- Markdown format for the rich text fields
|
||||||
|
|
||||||
#### [Front](https://github.com/Accords-Library/accords-library.com) (this repository)
|
#### [Front](https://github.com/Accords-Library/accords-library.com) (this repository)
|
||||||
|
|
||||||
- Language: [TypeScript](https://www.typescriptlang.org/)
|
- Language: [TypeScript](https://www.typescriptlang.org/)
|
||||||
- Queries: [GraphQL](https://graphql.org/)
|
- Queries: [GraphQL](https://graphql.org/)
|
||||||
- [GraphQL Code Generator](https://www.graphql-code-generator.com/) to automatically generated types for the operations variables and responses
|
- [GraphQL Code Generator](https://www.graphql-code-generator.com/) to automatically generated types for the operations variables and responses
|
||||||
|
@ -27,6 +29,10 @@
|
||||||
- State Management: [React Context](https://reactjs.org/docs/context.html)
|
- State Management: [React Context](https://reactjs.org/docs/context.html)
|
||||||
- Persistent app state using LocalStorage
|
- Persistent app state using LocalStorage
|
||||||
- Support for many screen sizes and resolutions
|
- Support for many screen sizes and resolutions
|
||||||
|
- Data quality testing
|
||||||
|
- Data from the CMS is subject to a battery of tests (about 20 warning types and 40 error types) at build time
|
||||||
|
- Each warning/error comes with a front-end link to the incriminating element, as well as a link to the CMS to fix it.
|
||||||
|
- Check for completeness, conformity, and integrity
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
@ -37,24 +43,29 @@ npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a env file:
|
Create a env file:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
nano .env.local
|
nano .env.local
|
||||||
```
|
```
|
||||||
|
|
||||||
Enter the followind information:
|
Enter the followind information:
|
||||||
|
|
||||||
```txt
|
```txt
|
||||||
URL_GRAPHQL=https://url-to.strapi-accords-library.com/graphql
|
URL_GRAPHQL=https://url-to.strapi-accords-library.com/graphql
|
||||||
ACCESS_TOKEN=genatedcode-by-strapi-api
|
ACCESS_TOKEN=genatedcode-by-strapi-api
|
||||||
NEXT_PUBLIC_URL_CMS=https://url-to.strapi-accords-library.com/
|
NEXT_PUBLIC_URL_CMS=https://url-to.strapi-accords-library.com/
|
||||||
NEXT_PUBLIC_URL_IMG=https://url-to.img-accords-library.com/
|
NEXT_PUBLIC_URL_IMG=https://url-to.img-accords-library.com/
|
||||||
|
NEXT_PUBLIC_URL_SELF=https://url-to-front-accords-library.com
|
||||||
```
|
```
|
||||||
|
|
||||||
Run in dev mode:
|
Run in dev mode:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./run_accords_dev.sh
|
./run_accords_dev.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
OR build and run in production mode
|
OR build and run in production mode
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./run_accords_build.sh
|
./run_accords_build.sh
|
||||||
./run_accords_prod.sh
|
./run_accords_prod.sh
|
||||||
|
|
Loading…
Reference in New Issue