diff --git a/CLAUDE.md b/.claude/CLAUDE.md similarity index 100% rename from CLAUDE.md rename to .claude/CLAUDE.md diff --git a/.env.docker b/.env.docker.example similarity index 85% rename from .env.docker rename to .env.docker.example index 93d6396..61ae940 100644 --- a/.env.docker +++ b/.env.docker.example @@ -1,4 +1,3 @@ -# Local development defaults (safe to commit-free; used by docker-compose.local.yml) POSTGRES_USER=postgres POSTGRES_PASSWORD=postgres POSTGRES_DB=foundry diff --git a/.gitignore b/.gitignore index 254c1d6..6a663bd 100644 --- a/.gitignore +++ b/.gitignore @@ -56,4 +56,7 @@ vitest.config.*.timestamp* .nx/migrate-runs docs apps/api/src/generated +*staging.yml uploads +.env +.env.docker diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..4a63161 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,327 @@ +# Contributing to Foundry + +Thanks for considering a contribution. Foundry is built by Tillertech to +solve a problem I hit myself running a consultancy, and it stays useful +only because the people using it push it forward. This document covers +what you need to know before opening an issue or a pull request - the +license, the feature-line policy, and how contributions actually get +reviewed. + +Read the sections that apply to what you're planning to do. If you're +opening an issue, the "Reporting bugs and requesting features" section +is enough. If you're opening a PR, read the license and CLA section +first. + +--- + +## License + +Foundry Community is licensed under **AGPL-3.0-or-later** (AGPLv3). + +The full license text is in [`LICENSE`](./LICENSE). The short version: + +- You can run Foundry for your own business, modify it, and deploy it on + your own infrastructure - without restriction, without notifying us, + without paying anything. +- You can fork it, extend it, and distribute your modifications, as long + as those modifications are also licensed under AGPLv3. +- If you modify Foundry and offer the modified version as a network + service to others (for example, hosting a modified Foundry as a SaaS), + AGPL requires you to publish your modifications under the same + license. +- For internal use by your own business - even by a large team - + AGPL imposes no obligations you would notice in day-to-day operation. + +If you are unsure how AGPL applies to your situation, ask before +building on it. We would rather answer a question up front than have a +contributor discover the constraint later. + +Tillertech separately maintains proprietary code (`foundry-ee` and +`foundry-cloud`) that is not part of this repository and is not covered +by AGPLv3. That code is not accepted as a contribution to this project. +This repository is Community only. + +--- + +## What belongs in Community vs. Cloud + +This is the question that comes up most often before someone starts +building, and it saves time to answer it up front. + +**The test.** If a feature is part of the client-to-cash lifecycle +(Clients - Quotes - Projects - Invoices - Payments - Documents), it +belongs in Community. No exceptions, no future re-litigation. If a +feature is about administration, compliance, multi-party access, or +operating at scale, it belongs in the commercial Cloud offering and +should not be built in this repository. + +**Community owns:** + +- Clients, Quotes, Projects, Invoices, Payments, Expenses, Documents +- Basic reporting and dashboards +- Recurring invoicing and retainer billing +- Time tracking against projects +- Multi-currency invoicing with VAT/GST handling +- Document branding on outbound documents (logo, name, colors, business + details) +- Realtime in-app notifications +- REST API - read/write access to your own data +- Plugin architecture and extension hooks - third parties can build and + distribute plugins for Community +- CSV/JSON import and export of all data +- E-signature acceptance on quotes +- Basic client-facing portal (view and download quotes and invoices via + tokenized links) +- Online payment collection on invoices (Stripe, direct) + +**Cloud owns (not this repository):** + +- SSO (SAML/OIDC) and SCIM provisioning +- RBAC beyond a basic owner/viewer split +- Immutable audit log +- Multi-workspace management +- Advanced template designer (build layouts from scratch) +- Full interactive client portal with quote acceptance workflow, + document exchange, and messaging +- Automation engine - conditional multi-step workflow rules +- Outbound webhooks and API keys for third-party integrations at scale +- White-label (hide that Foundry is the vendor) +- Approval workflows +- Managed hosting, backups, monitoring +- Priority support and SLA + +**The grey-area rule.** When a feature is not obviously one or the +other: does it serve one person running their own business, or does it +serve coordinating across a team, multiple parties, or a regulatory +requirement? First case belongs in Community. Second case belongs in +Cloud and should not be contributed here. + +**The standing promise.** The client-to-cash lifecycle stays free, +unlimited, and actively developed in Community - permanently. A new +lifecycle feature never triggers a "which tier does this go in" +negotiation. Community does not get worse to sell Cloud. + +If you have a feature idea and are not sure which side it falls on, +open a discussion issue before you start building. Getting it wrong +after a week of work is the outcome we most want to help you avoid. + +--- + +## Reporting bugs + +Before filing: + +- Search existing issues to check whether it has already been reported. +- Confirm the bug is in the latest release; if you are running an older + version, upgrade first and see whether it reproduces. +- If it involves a specific data condition, try to reproduce it from a + clean install. + +When you file, include: + +- Foundry version (`docker inspect` on the image tag is fine). +- Deployment context - Docker Compose on a VPS, on-prem, air-gapped, + etc. +- Postgres and Redis versions if you have customized them. +- What you did, what you expected, what actually happened. +- Relevant logs (`docker compose logs api`) with sensitive information + scrubbed. +- If the bug is UI-related, a screenshot or a short screen recording. + +Do not include real client data or invoice contents in bug reports. +Sanitized examples are always fine. + +--- + +## Requesting features + +Feature requests are welcome. Two things to check first: + +1. Read the "What belongs in Community vs. Cloud" section above. If + what you are asking for is a Cloud feature (SSO, audit log, RBAC, + etc.), the answer is "not in this repository" - but tell us anyway, + because that is exactly the signal that helps decide when to build + a self-hosted Enterprise SKU. +2. Search existing feature request issues. If one exists, add your use + case rather than opening a duplicate. Real use cases from real + businesses are what actually move a feature up the priority list. + +When requesting a feature, describe: + +- What you are trying to accomplish (the actual workflow, not the + feature name). +- What you currently do instead, and where it breaks down. +- Why the existing feature set does not solve it. + +Feature requests without a workflow context are hard to prioritize. +"Add X because Y competitor has it" is not a use case; "I need to bill +retainers across three currencies for a client that flips between +project-based and hourly, and here is how I currently do it" is. + +--- + +## Security disclosure + +If you find a security vulnerability, **do not open a public issue.** + +Email `hello@tillertech.io` with: + +- A description of the vulnerability. +- Reproduction steps. +- The affected version(s) if you can identify them. +- Your name and how you would like to be credited (or "anonymous"). + +We will acknowledge within 7 days. We do not currently offer a bug +bounty program, but confirmed reports get credit in the release notes +for the fix, and Tillertech reserves the right to send you something as +a thank-you. + +Please give us reasonable time to ship a fix before disclosing +publicly. If a fix is not shipping in a timeframe you consider +reasonable, tell us that directly - we would rather negotiate a +disclosure timeline than have you publish out of frustration. + +--- + +## Development setup + +You will need: + +- Node.js 20 LTS or newer +- pnpm 9 or newer +- Docker and Docker Compose (for Postgres, Redis, and optional local S3) +- A Postgres 15+ instance (Docker Compose brings one up locally) + +Setup: + +```bash +git clone https://github.com/tillertech/foundry.git +cd foundry +pnpm install +cp .env.example .env +docker compose -f docker-compose.dev.yml up -d +pnpm nx run api:migrate +pnpm nx run-many -t serve +``` + +The client runs on `http://localhost:4200` and the API on +`http://localhost:3000`. + +If any of those commands fail on a clean clone, that itself is a +reportable bug - first-run experience matters more than most bugs, and +we want to hear about it. + +--- + +## Pull request workflow + +**Before you write code:** + +- For a bug fix under ~50 lines, just open the PR - no issue needed. +- For anything larger, open an issue first and get a signal from a + maintainer that the direction is welcome. This is not a formality; + it saves you from writing a week of code that gets closed for a + reason that could have been discussed in ten minutes. +- If you are adding a dependency, mention it in the issue. New + dependencies are a real cost and often not the right call. +- If your change touches the schema, mention it in the issue. Schema + changes are additive-only in Foundry and go through more careful + review. + +**When you open the PR:** + +- Reference the issue it addresses (`Closes #123` or `Refs #123`). +- Keep the PR focused - one logical change per PR. Two unrelated fixes + should be two PRs. +- Include a short "what changed and why" in the description. Not a + novel; a paragraph. +- If it is a UI change, include a screenshot before/after. +- Make sure the CI passes locally before you push + (`pnpm nx run-many -t lint test`). + +**What we look for in review:** + +- Does it match the module boundary rules? Core code cannot import + from `libs/ee/*`. The lint rule enforces this, but reviewers will + also check. +- Does it follow existing patterns in the codebase? Consistency is + worth more than local elegance. +- Is it tested? Not every change needs a test, but changes to the + quote/invoice/payment logic almost always do. +- Is the commit history clean? Squash noisy WIP commits before we + merge. + +**Review timelines:** aim to acknowledge within a week, first +substantive review within two weeks. If a PR sits without a response +for longer than that, ping the issue - it has slipped through, not +been ignored. + +--- + +## Code style + +- TypeScript strict mode is on. Do not relax it locally. +- ESLint and Prettier configs live at the root and are what we run in + CI. Do not fight them. +- Use existing Nx generators for new libs, controllers, and modules - + do not hand-create the folders. This keeps tags and boundary rules + correct from the start. +- Prefer smaller, well-named files over large ones. Public exports + from each lib go through the `index.ts` barrel. + +--- + +## What we do not accept + +Being direct so nobody wastes time: + +- Contributions to Cloud/Enterprise features (see the boundary section + above). Even good code for an SSO integration or an audit log is out + of scope for this repository. If you want to build one of these, + reach out and we can discuss whether a self-hosted Enterprise SKU is + something we should be working on together. +- Contributions that reshape the schema breakingly. All schema changes + are additive. Migrations remove tables only through a deprecation + cycle that takes at least one major release. +- Contributions that add telemetry or "phone home" behavior of any + kind. Foundry runs offline by design; this is not negotiable. +- Contributions that introduce dependencies without a real + justification. Every added dependency is future maintenance for + everyone. +- Drive-by rewrites of significant subsystems without a prior + discussion issue. Not because we don't want the improvement, but + because a rewrite that lands without prior conversation almost + always misses context that a five-minute discussion would surface. + +--- + +## A note on tone + +Public issues, discussions, and PR reviews all follow the same rule: +be direct, be specific, be kind. Direct honesty is more useful than +padded feedback; specifics are more useful than gestures; kindness is +what makes the first two land. + +Push back on decisions you think are wrong - including decisions I +made. If you think a feature is in the wrong tier, if you think the +architecture is off, if you think the roadmap is missing something +important, say so. This project gets better when someone catches a +contradiction I missed. + +That goes in both directions. If a maintainer pushes back on your PR, +it is about the code, not you. If it feels otherwise, tell us - +directly - and we will fix it. + +--- + +## Questions + +- General discussion: GitHub Discussions on this repo. +- Bug reports: GitHub Issues on this repo. +- Anything about Cloud, licensing, or commercial arrangements: + `hello@tillertech.io`. + +Thanks for reading this far. If you are about to open your first issue +or PR, welcome - Foundry is more useful because you are here. + +- Marvin Kweyu, Tillertech diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md index 7cd17f4..5c85e9d 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,73 @@ -# Foundry -> The modern workspace for independent consultants +

+

Foundry

+

The modern workspace for independent consultants

+

+ + +![Foundry](./images/preview.png) ## Project Overview -This repository demonstrates a production-ready Angular monorepo with: +Foundry is the solution to consultancy management in the service industry. -- **2 Applications** - - `client` - Angular e-commerce application with product listings and detail views - - `api` - Backend API with Docker support serving product data +- [Project Overview](#project-overview) +- [Local Development](#local-development) + - [Docker(Recommended)](#dockerrecommended) + - [Manual(Docs WIP)](#manualdocs-wip) +- [Notes on Architecture(WIP)](#notes-on-architecturewip) + - [1. Module Boundaries](#1--module-boundaries) + - [2. Docker Integration](#2-docker-integration) + - [3. Playwright E2E Testing](#3-playwright-e2e-testing) + - [4. Vitest for Unit Testing](#4-vitest-for-unit-testing) +- [Project Structure(WIP)](#project-structurewip) +- [Understanding Tags](#understanding-tags) +- [Useful Commands](#useful-commands) +- [Adding New Features](#adding-new-features) + - [Generate a new Angular application:](#generate-a-new-angular-application) + - [Generate a new Angular library:](#generate-a-new-angular-library) + - [Generate a new Angular component:](#generate-a-new-angular-component) + - [Generate a new API library:](#generate-a-new-api-library) -- **6 Libraries** - - `@org/feature-products` - Product listing feature (Angular) - - `@org/feature-product-detail` - Product detail feature (Angular) - - `@org/data` - Data access layer for client features - - `@org/shared-ui` - Shared UI components - - `@org/models` - Shared data models - - `@org/products` - API product service library -- **E2E Testing** - - `client-e2e` - Playwright tests for the client application +## Local Development + +### Docker(Recommended) + +**Basic requirements** +- Docker +- Docker Compose + + +```sh +cp .env.docker.example .env.docker +docker compose -f docker-compose.local.yml up +``` + +If you have [just](https://just.systems/man/en/) installed: + +```sh +cp .env.docker.example .env.docker +just develop +``` + + +The complete set of commands can be found with: + +```sh +just +``` + + +### Manual(Docs WIP) + +The manual setup process is (WIP) -## Quick Start ```bash -# Clone the repository -git clone -cd -# Install dependencies -# (Note: You may need --legacy-peer-deps) -npm install +npm install --legacy-peer-deps # Serve the Angular client application (this will simultaneously serve the API backend) npx nx run client:serve @@ -58,10 +94,33 @@ npx nx run-many -t lint test build e2e --parallel=3 # Visualize the project graph npx nx graph ``` +---- + -## Featured Nx Capabilities -This repository showcases several powerful Nx features: +The client runs on `http://localhost:4200` and the API on `http://localhost:3000`. + +This repository demonstrates a production-ready Angular monorepo with: + + +## Notes on Architecture(WIP) +- **2 Applications** + + - `client` - Angular e-commerce application with product listings and detail views + - `api` - Backend API with Docker support serving product data + +- **6 Libraries** + + - `@org/feature-products` - Product listing feature (Angular) + - `@org/feature-product-detail` - Product detail feature (Angular) + - `@org/data` - Data access layer for client features + - `@org/shared-ui` - Shared UI components + - `@org/models` - Shared data models + - `@org/products` - API product service library + +- **E2E Testing** + - `client-e2e` - Playwright tests for the client application + ### 1. Module Boundaries @@ -119,7 +178,7 @@ npx nx run client-e2e:e2e-ci [Learn more about E2E testing →](https://nx.dev/docs/technologies/test-tools/playwright) -### 4. ⚡ Vitest for Unit Testing +### 4. Vitest for Unit Testing Fast unit testing with Vite for Angular libraries: @@ -131,27 +190,7 @@ npx nx run data:test npx nx run-many -t test ``` -[Learn more about Vite testing →](https://nx.dev/docs/technologies/build-tools/vite) - -### 5. Self-Healing CI - -The CI pipeline includes `nx fix-ci` which automatically identifies and suggests fixes for common issues: - -```bash -# In CI, this command provides automated fixes -npx nx fix-ci -``` - -This feature helps maintain a healthy CI pipeline by automatically detecting and suggesting solutions for: - -- Missing dependencies -- Incorrect task configurations -- Cache invalidation issues -- Common build failures - -[Learn more about self-healing CI →](https://nx.dev/docs/features/ci-features/self-healing-ci) - -## Project Structure +## Project Structure(WIP) ``` ├── apps/ diff --git a/docker-compose.staging.yml b/docker-compose.staging.yml deleted file mode 100644 index f2decbe..0000000 --- a/docker-compose.staging.yml +++ /dev/null @@ -1,54 +0,0 @@ -services: - redis: - container_name: foundrycache - image: redis - volumes: - - redis:/data - restart: always - networks: - - foundry - - foundryapi: - container_name: foundryapi - build: - context: . - dockerfile: Dockerfile.api.production - environment: - NODE_ENV: production - REDIS_HOST: redis - UPLOADS_DIR: /app/uploads - env_file: - - ./.env - ports: - - 3007:3000 - volumes: - - uploads:/app/uploads - depends_on: - redis: - condition: service_started - restart: always - networks: - - foundry - - foundryclient: - container_name: foundryclient - build: - context: . - dockerfile: Dockerfile.client.production - ports: - - 8083:80 - depends_on: - foundryapi: - condition: service_started - restart: always - networks: - - foundry - -volumes: - postgres_data: - redis: - uploads: - -networks: - foundry: - name: foundry diff --git a/images/preview.png b/images/preview.png new file mode 100644 index 0000000..2d37bb4 Binary files /dev/null and b/images/preview.png differ