alcpereira / 100hunters

Let's goooo
6 stars 11 forks source link

Folders convention docs #22

Open alcpereira opened 2 months ago

alcpereira commented 2 months ago

Description

We are using an opinionated folder structure and we should share about those directives with new users. At this current stage of the project we have the following structure:

├── app - Remix source folder
│   ├── components - React components, including tests and stories
│   ├── db - Database operations
│   └── routes - Remix routes
│       ├── route-example - Remix route example, it should include the utils for this route 
├── docs - Docs for the project
├── public - Public files for assets like favicon
└── utils - Utils for the project
    ├── mermaid - Mermaid tool to generate schema illustration
    └── seed - Seeding for database

You can use tree -I 'node_modules|build -d on UNIX system to generate quickly the folder structures.

ACs