An open API service indexing awesome lists of open source software.

https://github.com/temando/project-structures


https://github.com/temando/project-structures

Last synced: 8 months ago
JSON representation

Awesome Lists containing this project

README

          

# Project Structures

A bunch of project structures we want to standardize on, and distribute via a yoeman generator.

* [Project Structures](#project-structures)
* [`./pieces`](#piecespieces)
* [`./projects`](#projectsprojects)
* [Purpose](#purpose)
* [Contributing](#contributing)

--------

## [`./pieces`](./pieces)

Contains pieces of a project that may or may not be used in a specific project type. The `global` folder is intended to be included in all projects, however.

## [`./projects`](./projects)

Contains project entry points. These are missing the `./pieces/global` and other optional pieces.

## Purpose

This project should include:

- Parts of projects, without repetition.
- No example files, should not have to delete anything.
- A Yeoman generator for:
- Interactive project creation
- Project uplift via codemods & other merge strategies
- Concepts which make projects DRY, such as:
- An inherited `tsconfig.json`
- An inherited `webpack.config.ts`

## Contributing

Just make a PR (eg. hit the edit button on a file). It will probably get accepted.

There are lots of pieces missing and various workflows unaccounted for.