Skip to content

A repository to demonstrate how thorough project documentation can be created from simple starting instructions.

Notifications You must be signed in to change notification settings

spencer-owens/new-god-flow.1

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

Project Setup Guide

This repository contains a structured approach for building a new Vite + React application (code-named "AutoCRM"). It follows a series of documents that guide you through project context, user flows, technology stack choices, and best practices before outlining a phased approach to development.


How @new-project-setup.md Works

The file @new-project-setup.md provides a detailed sequence of steps and prompts, starting from a simple project overview and ending with a fully organized, phased approach to building the application. This file helps you:

  1. Understand the overall goals and scope of the project (via the initial "Project Overview").
  2. Incrementally build supporting documents (user flow, tech stack decisions, UI/theme rules, etc.).
  3. Embody best practices in folder structure, coding style, checklist-based development, and environment setup.
  4. Follow a clearly defined, phase-by-phase plan for implementing each feature set in both frontend and backend contexts.

By reading and following each step in @new-project-setup.md, you'll quickly bootstrap a robust environment for AutoCRM, ensuring all participants or contributors operate with the same architectural understanding, coding guidelines, and clear objectives.


If you have any questions or want to expand upon a particular feature or workflow, consult the corresponding doc under /docs for further context and instructions.

Happy building!

About

A repository to demonstrate how thorough project documentation can be created from simple starting instructions.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published