|
1 | 1 | # footer-templates-app
|
2 | 2 |
|
3 | 3 | Project is based on the [Create-React-App](https://create-react-app.dev/docs)
|
4 |
| - |
5 |
| -After creation, your project's directory structure should look like this: |
6 |
| - |
7 |
| -- .git - [directory used by GIT for project's version control](https://git-scm.com/docs/git) |
8 |
| -- public - [static assets](https://create-react-app.dev/docs/using-the-public-folder) |
9 |
| -- src - actual project's code |
10 |
| - - `./src/footer-templates-app` - a directory where you put your project's modules, which then can be imported using absolute path (`footer-templates-app/**`) |
11 |
| - - `./src/example` - example project. This directory should be either merged with `./src/footer-templates-app` (if you'd like to use it as a base for your project) or deleted |
12 |
| - - `./src/scripts` - scripts that allows to automatize long-lasting, repeatable tasks (e.g license checking) |
13 |
| -- .audit-ci.js - [audit-ci configuration file](https://github.com/IBM/audit-ci) |
14 |
| -- babel.config.js - [babel configuration file](https://github.com/babel/babel) |
15 |
| -- .browserslistrc - [Browserlist](https://github.com/browserslist/browserslist) |
16 |
| -- .editorconfig - [Editorconfig](https://editorconfig.org) |
17 |
| -- .env - environment variables config |
18 |
| -- .env.template - environment variables config template |
19 |
| -- .eslintignore - list of glob patterns that define which files should be ignored by ESLint |
20 |
| -- .eslintrc.js - [ESLint configuration file](https://github.com/eslint/eslint) |
21 |
| -- .gitignore - list of glob patterns that define which files should be ignored by GIT |
22 |
| -- .huskyrc.json - [Husky configuration file](https://github.com/typicode/husky) |
23 |
| -- .lintstagedrc.js - [🚫 💩 lint-staged configuration file](https://github.com/okonet/lint-staged#lintstagedrc-example) |
24 |
| -- package.json - [NPM package manifest](https://docs.npmjs.com/configuring-npm/package-json.html) |
25 |
| -- package-lock.json - [description of the installed packages tree](https://docs.npmjs.com/configuring-npm/package-lock-json.html) |
26 |
| -- .prettierrc - [Prettier configuration file](https://prettier.io/docs/en/configuration.html) |
27 |
| -- README.md |
28 |
| -- tsconfig.json [TypeScript configuration file](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#using-tsconfigjson-or-jsconfigjson) |
29 |
| - |
30 |
| -For the project to build, these files must exist with exact filenames: |
31 |
| - |
32 |
| -- `public/index.html` |
33 |
| -- `src/index.tsx` |
34 |
| - |
35 |
| -Some of the directories also have their own `README.md` included, so please check those as well. |
0 commit comments