README.md

Web interface for Azzurra Capital

Project created with Gatsby and Typescript.

Base project and modules

Clone the repository and run yarn from inside the root folder to install all dependencies.

Start

Use yarn start to run the app in development mode at https://localhost:8000

Folder structure and relevant files

root
├── public                             # Static files and base HTML and metadata from create-react-app
│
├── src
│    ├── components                    # Components used in views
│    │    └── ...
│    │
│    ├── constants                     # Export named constants for the general app
│    │    └── ...
│    │
│    ├── images                        # Images used in views and components (svg, png, jpg, ...) to relative path
│    │    └── ...
│    │
│    ├── modules                       # Static assets imported at build time
│    │    ├── hooks                    # React hooks functions
│    │    │    └── ...
│    │    │
│    │    └── utils                    # Common small utility functions
│    │
│    ├── styles                        # Global styles and theme
│    │    └── ...
│    ├── pages                         # Pages for routing
│    │    ├── en                       # Home page for english language
│    │    │   └── ...
│    │    ├── 404.tsx                  # 404 page
│    │    └── index.tsx                # Home page for portuguese language
│    │
│    ├── templates                     # Templates for generating page or component used in many places
│    │    └── ...
│    │
│    └── types                         # Type files for components and functions
│         └── ...
│
│    
├── tailwind.config.js                 # Tailwind configuration
├── tsconfig.json                      # Typescript configuration
├── tsconfig.paths.json                # Typescript project paths configuration
├── gatsby-config.ts                   # Gatbsy configuration
└── ...